使用指南 API接口 审核规范

产品代码: isms(行业短信)、smsn(短信通知)、smsv(短信验证码)

版本: v1

服务名: smsService

方法名: send

请求参数,json格式
名称 类型 是否必须 描述
templateId String Y 模板ID,提交模板内容审核通过后由平台提供,模板内容中的动态参数用${i}表示,例如您本次的注册验证码为:${0}
templateArgs String[] N 按数组索引i顺序依次填入模板中${i}的参数值
phones String Y 接收手机号码,多个手机号码用英文逗号分隔,最多500个
subcode String N 自定义扩展子码,必须是4位数字。未填则使用签名对应子码
sendtime String N 定时发送时间,格式yyyy-MM-dd HH:mm:ss,为空或早于当前时间则立即发送

请求示例

                    
{
    "templateId":"6846680",
    "templateArgs":[
        "361279"
    ],
    "phones":"15711666132, 15711666133",
    "subcode":"8528",
    "sendtime":"2014-05-05 12:30"
}
                    
                
返回结果,json格式
名称 类型 描述
msgid String 该批短信编号
failPhones String 如果提交的号码中含有错误(格式)号码将在此显示

返回示例

                    
{
    "msgid":"f02adaaa99c54ea58d626aac2f4ddfa8",
    "failPhones":"12935353535,110,130123123"
}
                    
                
错误码说明
错误码 描述
906101/907101/908101 系统内部错误
906102/907102/908102 短信请求消息格式有误
906103/907103/908103 未传入短信模板ID
906104/907104/908104 无效的短信模板ID
906105/907105/908105 未传入接收手机号码
906106/907106/908106 接收手机号码数超出限制
906107/907107/908107 输入变量个数少于模板定义变量个数
906108/907108/908108 扩展子码长度超出限制
906109/907109/908109 模板对应短信签名为空,请联系相关运营人员
906110/907110/908110 短信内容存在敏感词,请联系相关运营人员
906111/907111/908111 发送不符合模板限制组的限制,请联系运营人员
906112/907112/908112 短信状态查询次数超出500条的限制
906113/907113/908113 该批次短信的额度不够了,请充值
请求参数,json格式
名称 类型 描述
appId String 应用ID
appKey String 用户KEY
path String 请求方法
msgId String 短信信息ID
phone String 接收短信手机号
status String 发送状态,0为成功
desc String 状态描述
reportTime String 回调时间

请求示例

                    
{
    "header": {
        "appId": "f9eb1019b7b29f28064234fc4b0642b0",
        "appKey": "6416b416c30b32fb306c26b7c8acbf69",
        "path": "/sms/smsService/getSmsInfo"
    },
    "body": {
        "msgId": "b3b01457df164ce8b15b28356bfdbc91",
        "phone": "17001108008",
        "status": "0",
        "desc": "发送成功",
        "reportTime": "2017-08-31 11:09:41"
    }
}

                    
                
返回结果,json格式
名称 类型 描述
code Int 编码,0为成功,1为失败
msg String 描述

返回示例

                    
{
    "code": 0,
    "msg": "success"
}
                    
                

方法名: getSmsStatus

请求参数,json格式,body为数组格式
名称 类型 是否必须 描述
msgid String Y 短信唯一标识ID
phone String Y 接收短信手机号

请求示例

                    
{
    "header": {
        "appId": "f9eb1019b7b29f28064234fc4b0642b0",
        "appKey": "6416b416c30b32fb306c26b7c8acbf69",
        "startTime": "2017-11-08 17:09:41"
    },
    "body": [
    {
        "msgid": "f691f363728b430f9de86ca2dcab9f76",
        "phone": "18507717847"
    },
    {
        "msgid": "f691f363728b430f9de86ca2dcab9f76",
        "phone": "12345678901"
    }]
}

                    
                
返回结果,json格式
名称 类型 描述
phone String 手机号码
msgid String 短信唯一标识ID
status String 发送状态:1表示通道未返回状态,2表示发送成功,3表示发送失败,4表示提交失败
reportTime String 状态报告时间
desc String 状态报告描述

返回示例

                    
[
    {
        "phone": "18507717847",
        "msgid": "f691f363728b430f9de86ca2dcab9f76",
        "status": "1",
        "desc": "通道未返回状态",
        "reportTime": "2017-09-05 17:20:26"
    },
    {
        "phone": "18507717847",
        "msgid": "2a2b32ca4f514585bcf29c93defc7805",
        "status": "1",
        "desc": "通道未返回状态",
        "reportTime": "2017-09-05 17:19:06"
    }
]

                    
                
错误码说明
错误码 描述
906112/907112/908112 短信状态查询次数超出500条的限制

产品代码: ussd

版本: v1

服务名: ussdService

方法名: deliverUssd

请求参数,json格式
名称 类型 是否必须 描述
dst String Y 目标号码
template String Y 模板编号,用户在服务端设置的模板,需要审核通过以后才能使用
argv String[] Y 模板中需要填充的参数,参数内容为UTF-8编码

请求示例

                    
{
    "dst": "13712345678",
    "template": "480",
    "argv": [
        "中国东信",
        "133333"
    ]
}
                    
                
返回结果,json格式
名称 类型 描述
taskid String 为消息生成的唯一任务ID
dst String 目标号码,与请求中的dst一致

返回示例

                    
{
    "taskid": "1458540307123456",
    "dst": "13712345678"
}
                    
                
错误码说明
错误码码(dst为联通或电信号码) 描述 说明
90110000001 System Error 系统错误
90130001002 Argument Error: invalid dst dst参数不合法
90130001003 Argument Error: invalid template template参数不合法
90130001004 Argument Error: invalid argv argv参数不合法
90130001005 Argument Error: include sensitiveword 存在敏感词
90130002001 Server Error: cy server timeout 彩印服务器响应超时
90130002002 Server Error: cy server return err 彩印服务器返回错误
90130002003 Server Error: cy server response body is nil 彩印服务器响应体为空
90130002004 Server Error: cy server response body is not json 彩印服务器响应体不合法
90130002005 Server Error: cy server response status error 彩印服务器响应体状态错误
90130002006 EOP Error:Response of delivery request timeout for EOP EOP未收到投递请求消息的响应
90130002007 EOP Error:Response of delivery request from operator ERROR EOP收到的投递请求消息响应错误
90130002008 EOP Error: delivery result from operator timeout EOP未收到运营商的结果通知
90130002009 EOP Error:delivery result from operator Unknown ERROR EOP收到运营商结果通知响应码无法识别
90130002010 Operator Error:The USSD_delivery failed 运营商返回USSD投递失败
90130002011 Operator Error:The flashSM_delivery failed 运营商返回闪信投递失败
90130002012 Operator Error:Invalid target number 运营商返回无法识别的投递号码
90130002013 Operator Error:target in blacklist 运营商返回投递号码在黑名单中
90130002014 Operator Error:USSD notification timeout 运营商返回USSD投递结果通知超时
90130002016 Operator Error:flashSM receipt report timeout 运营商返回闪信回执报告超时
90130002017 Operator Error:Flow over the limit 运营商返回超出流量限制
90130002018 Operator Error:Sensitive words found 运营商返回含有敏感词
90130002019 Operator Error:Length of the message content exceeds limit 运营商返回消息内容长度超过限制
90130002020 Operator Error:target segment is restricted 运营商返回投递号段受限
90130002021 Operator Error:The interactive USSD delivery notification timeout 运营商返回交互式USSD未收到回复
90130002022 Operator Error:can not deliver to the same phone in a short time 不能短时间内连续向同一个手机号投递
90130002023 Operator Error:To the same phone of delivery times reached the limit today 一天内向同一个号码投递次数达到上限
错误码(dst为移动号码) 描述 说明
90110 Delivery request receive failed 投递请求接收失败
901114 Invalid target number 无法识别的投递号码
901115 target in blacklist 投递号码在黑名单中
901120 target segment is restricted 投递号段受限
901121 Beyond fluid control 超出流量限制
901126 Target delivery time interval limit 不能短时间内连续向同一个号码投递
901127 Target delivery day sum limit 一天内向同一个号码投递次数达到上限
901201 Reach maximum delivery limit 到达套餐上限停发
901202 Illegal word found 含有敏感词
901206 Length of the message content exceeds limit 消息内容长度超过限制
901500 Unknown error 未知处理状态
901501 Service error 服务处理错误

产品代码: voice

版本: v1

服务名: voiceService

方法名: verify

请求参数,json格式
字段值 字段类型 约束 说明
voiceId String 必选 语音文件ID,用于验证码提示音。提前申请或上传语音语音文件,审核通过后,由平台分配ID。
verifyCode String 必选 验证码内容,为数字和英文字母,不区分大小写,长度4-8位
displayNum String 可选 被叫终端上显示的主叫号码,提前向平台申请。
calleeNum String 必选 被叫号码。[示例]18682206620
repeatTimes String 可选 循环播放次数,1-3次,默认播放1次。
maxCallTime String 可选 该通话最大通话时长,单位为秒,到时间自动挂机

请求示例

                    
{
    "voiceId": "123456",
    "verifyCode": "1234",
    "displayNum": "955169",
    "calleeNum": "18682206620",
    "repeatTimes": "1",
    "maxCallTime": "30",
}
                    
                
返回结果,json格式
字段值 字段类型 说明
callId String 会话ID,用于关联结果通知消息

返回示例

                    
{
    "callId": "50b1ca5f003645a4af9517fd098b2319"
}
                    
                
响应码说明
响应码 描述 说明
90300000000 Success 成功
90310000001 System Error 系统错误
90310001001 User have no right to use this to displaynumber 用户无权使用此来显号码
90310001002 Voice template does not exist 话音模板不存在
90310001003 Voice template status is not normal 话音模板状态不正常
90310001004 South network error 南向网元返回错误
90310001005 CalleeNum format error 参数“calleeNum”格式错误,请使用开发文档要求的号码格式。
90310001006 VerifyCode format error 验证码格式错误
90310001007 RepeatTimes Over range 重复次数超过范围

方法名: notify

请求参数,json格式
字段值 字段类型 约束 说明
operation String 必选 操作类型:
play:放音
playAndCollect:放音收号
voiceId String 必选 语音文件ID,用于提示音。提前申请或上传语音文件,审核通过后,由平台分配ID。
displayNum String 可选 被叫终端上显示的主叫号码,提前向平台申请。
calleeNum String 必选 被叫号码[示例]18682206620
repeatTimes String 可选 循环播放次数,1-3次,默认播放1次。
maxCallTime String 可选 该通话最大通话时长,单位为秒,到时间自动挂机

请求示例

                    
{
    "operation": "play",
    "voiceId": "123456",
    "displayNum": "955169",
    "calleeNum": "18682206620",
    "repeatTimes": "1",
    "maxCallTime": "30",
}
                    
                
返回结果,json格式
字段值 字段类型 说明
callId String 会话ID,用于关联结果通知消息

返回示例

                    
{
    "callId": "50b1ca5f003645a4af9517fd098b2319"
}
                    
                
响应码说明
响应码 描述 说明
90300000000 Success 成功
90310000001 System Error 系统错误
90310001001 User have no right to use this to displaynumber 用户无权使用此来显号码
90310001002 Voice template does not exist 话音模板不存在
90310001003 Voice template status is not normal 话音模板状态不正常
90310001004 South network error 南向网元返回错误
90310001005 CalleeNum format error 参数“calleeNum”格式错误,请使用开发文档要求的号码格式。
90310001006 VerifyCode format error 验证码格式错误
90310001007 RepeatTimes Over range 重复次数超过范围

产品代码: data

版本: v1

服务名: dataService

方法名: order

请求参数,json格式
参数 类型 必填 备注
mobile String 手机号码
packageSize int 流量包大小(10 ,70,500,1000,2000等)
clientOrderId String 客户订单号,6-32位字符串,(字母或数字)

请求示例

                    
{
    "mobile": "18621764382",
    "clientOrderId": "201609211133",
    "packageSize": 30
}
                    
                
返回结果,json格式
参数 类型 备注
failPhones String 处理失败的手机号
clientOrderId String 客户订单号

返回示例

                    
{
    "failPhones": "",
    "clientOrderId": "201609211133"
}
                    
                
响应码说明
响应码 描述
90500 订单提交成功
90501 缺少必要参数
90503 packageSize错误
90504 clientOrderId参数错误
90506 手机号错误/此手机号为黑名单用户
90507 手机号解密出错/密钥不对应
90528 未找到相应产品
90529 订单提交失败
90531 创建订单失败
90539 系统错误
90540 产品维护中
90541 此订单号已存在
90551 未开通流量业务
905101 参数错误

产品代码: spn

版本: v1

服务名: spnService

方法名: axbBind

请求参数,json格式

参数 类型 意义 是否必填 备注
requestId string 业务id Y 消息请求标识
telA string 真实号码 Y -
telB string 对端号码 Y -
subts string 绑定时间 Y 格式为YYYYMMDDhhmmss。时间采用北京时间,24小时制。
expiration string 过期时间 Y 单位:秒, 自绑定时间开始后expiration秒自动解绑;0表示不限制时间,不会自动解绑
callrecording string 录音控制 N 可选。仅下列值有效。默认:0(不开通录音功能)。
0:不开通录音功能
1:开通录音功能
calldisplay string 来显控制 N 可选。 针对AXB中的A或者B作为主叫时,是否在被叫上显示来话的真实号码。默认为0,0(都不显示真实号码)。
0:不显示真实号码
1:显示真实号码
来显控制按照“A->B时B上的显示,B(N)->A时在A上的显示”的顺序填写编码,编码之间以逗号分隔。“其他号码”的来显控制,同B(N)设置。
场景(1)A -> B,A 显示为X,B(N)-> A,B(N)显示为X,calldisplay为“0,0”;
场景(2)A -> B,A 显示为X,B(N)-> A,B(N)显示为B(N),calldisplay为“0,1”;
场景(3)A -> B,A 显示为A,B(N)-> A,B(N)显示为X,calldisplay为“1,0”;
场景(4)A -> B,A 显示为A,B(N)-> A,B(N)显示为B(N),calldisplay为“0,0”.

请求示例

                    
{
    "requestId": "1234567890",
    "telA": "13900000000",
    "telB": "13005711234",
    "subts": "20150920190126",
    "expiration": "7200",
    "callrecording": "0",
    "calldisplay": "0,0"
}
                    
                
返回结果,json格式
参数 类型 意义 是否必须 备注
subid string 绑定id M -
telX string 小号 M -

返回示例

                    
{
    "subid": "100X571X0000000001",
    "telX": "13720056199"
}
                    
                
响应码说明
响应码 描述 定义
9020 成功 请求报文成功被处理
902400 格式异常 请求报文格式不正确
902401 认证未通过 请求的来源或者请求的签名未通过校验。
902402 小号已经使用 请求中要求绑定的小号已经被分配给其他用户。
902403 绑定关系不存在 第三方业务系统提交的请求中提供的“绑定关系标识”,在小号业务系统中不存在。
902404 绑定数据不一致 请求中提供的“绑定关系标识”在小号业务系统中查询获得的“真实号码”和“小号”绑定关系,与请求中提供的“真实号码”与“小号”不一致。
902429 请求过多 第三方业务系统在一定时间内提交了过多的请求。第三方业务系统在访问某些特定服务接口时,可能会出现该错误。
902501 业务处理超时 小号业务系统内部处理引起的超时。第三方业务系统可以尝试重新提交请求。
902502 服务暂时不可用 小号业务系统当前不可用,可能是因为系统负载过重,或者暂时停机。
902503 服务接口被禁止 小号业务系统已经关闭相关服务。后续对于该服务的请求是被禁止的。
其他 待定义 -

方法名: axbUnbind

请求参数,json格式
参数 类型 意义 是否必填 备注
subid string 绑定id M -

请求示例

                    
{
    "subid": "A2101X571X0009615400"
}
                    
                
响应码说明
响应码 描述 定义
9020 成功 请求报文成功被处理
902400 格式异常 请求报文格式不正确
902401 认证未通过 请求的来源或者请求的签名未通过校验。
902402 小号已经使用 请求中要求绑定的小号已经被分配给其他用户。
902403 绑定关系不存在 第三方业务系统提交的请求中提供的“绑定关系标识”,在小号业务系统中不存在。
902404 绑定数据不一致 请求中提供的“绑定关系标识”在小号业务系统中查询获得的“真实号码”和“小号”绑定关系,与请求中提供的“真实号码”与“小号”不一致。
902429 请求过多 第三方业务系统在一定时间内提交了过多的请求。第三方业务系统在访问某些特定服务接口时,可能会出现该错误。
902501 业务处理超时 小号业务系统内部处理引起的超时。第三方业务系统可以尝试重新提交请求。
902502 服务暂时不可用 小号业务系统当前不可用,可能是因为系统负载过重,或者暂时停机。
902503 服务接口被禁止 小号业务系统已经关闭相关服务。后续对于该服务的请求是被禁止的。
其他 待定义 -