文档中心 > API类目 > 驿马前台api

cainiao.yima.sms.template.get (小件员SDK短信模版获取API)

提供小件员查询本公司定制的短信模板支持

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
version Number 可选 0
  • 默认值:0
  • 客户端存在的版本号
    user_id String 可选 10001
  • 默认值:40291
  • 小件员在菜鸟系统的账号ID
    session_code String 可选 1aabef12qwsadfdfsad2x
  • 默认值:1aabef12qwsadfdfsad2x
  • 小件员session code

    响应参数

    名称 类型 示例值 描述
    data SmsTemplateList "" 成功返回的数据
    • template_list
    • SmsTemplate []
    • ""
    • 短信模板列表
    • └ content
    • String
    • ""
    • 短信模板的内容
    • parameters
    • SmsTemplateAttribute []
    • ""
    • 短信模板中的参数
    • └ default_value
    • String
    • ""
    • 参数的默认值
    • └ desp
    • String
    • ""
    • 参数的描述
    • └ max
    • Number
    • 0
    • 参数的最大值(number 类型)/最大长度,字符串类型)0表示忽略
    • └ min
    • Number
    • 0
    • 参数的最小值(number 类型)/最小长度,字符串类型)0表示忽略
    • └ suffix
    • String
    • ""
    • 参数后缀
    • └ title
    • String
    • ""
    • 参数的变量名称
    • └ type
    • String
    • ""
    • 参数的类型,是否可以编辑
    • └ value_type
    • String
    • ""
    • 参数的数值类型,NUMBERVALUE1:number或者STRINGVALUE:字符串
    • └ color
    • Number
    • 0x000000
    • 参数在模板中的颜色显示
    • └ title
    • String
    • ""
    • 模板的名称
    • └ type
    • Number
    • ""
    • 模板类型 派前/揽收
    • └ type_title
    • String
    • ""
    • 模板类型的字符串描述 "派前/揽收"
    • └ color
    • Number
    • 0
    • 模板装饰颜色
    • └ template_id
    • String
    • ""
    • 模板在阿里通信系统中的ID
    • └ version
    • Number
    • 1
    • 模板列表的版本号
    status_code String "" 返回状态码
    status_message String "" 错误描述信息
    is_success Boolean false 是否成功

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoYimaSmsTemplateGetRequest req = new CainiaoYimaSmsTemplateGetRequest();
    req.setVersion(0L);
    req.setUserId("10001");
    req.setSessionCode("1aabef12qwsadfdfsad2x");
    CainiaoYimaSmsTemplateGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_yima_sms_template_get_response>
        <data>
            <template_list>
                <sms_template>
                    <content>&quot;&quot;</content>
                    <parameters>
                        <sms_template_attribute>
                            <default_value>&quot;&quot;</default_value>
                            <desp>&quot;&quot;</desp>
                            <max>0</max>
                            <min>0</min>
                            <suffix>&quot;&quot;</suffix>
                            <title>&quot;&quot;</title>
                            <type>&quot;&quot;</type>
                            <value_type>&quot;&quot;</value_type>
                            <color>0x000000</color>
                        </sms_template_attribute>
                    </parameters>
                    <title>&quot;&quot;</title>
                    <type>&quot;&quot;</type>
                    <type_title>&quot;&quot;</type_title>
                    <color>0</color>
                    <template_id>&quot;&quot;</template_id>
                </sms_template>
            </template_list>
            <version>1</version>
        </data>
        <status_code>&quot;&quot;</status_code>
        <status_message>&quot;&quot;</status_message>
        <is_success>false</is_success>
    </cainiao_yima_sms_template_get_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部