1简介
短信服务器SMSSERVERv1.27及以上版本，提供了一个高可用性的开放接口，以便用户能轻松对接到第三方短信平台。
简单示意图如下： 本接口采用http+json结合的方式。
基本格式如下：以post方式请求： http:///goip/<接口名>/以json格式提交参数：
{"auth":{"username":"登录名","password":"登录密码"},其他参数…
}
注：
1.【"auth":{"username":"登录名","password":"登录密码"}】，任何一请求都必须携带短 信服务器的登录认证信息。
若不携带，或登录名/密码错误，则服务器将返回
401错误。
2.<接口名>是指不同功能的入口：sendsms，发送短信querysms，查询短信的发送状态querylines，查询全部GoIP线路的状态
3.请求URL中，末尾的“/”字符不可省略
4.数据编码全部采用UTF-
8 2发送短信 2.1发送短信请求 接口名：sendsms json参数： 键名 描述 auth 必须，所有请求都必须携带的认证信息 provider 可选，指定归属于某个运营商的GOIP线路发送短信 goip_line 可选，指定某个GOIP线路发送短信 number 必须，指定接收人号码；可用“,”隔开提交多个号码(上限9999个) content 必须，指定要发送的短信内容 示例： 使用归属于运营商【移动】的GOIP线路，给号码、、 发送短信，内容为“测试”。
POST方式请求http:///goip/sendsms/{"auth":{"username":"登录名","password":"登录密码"},"provider":"移动","number":",,","content":"测试"}
补充说明：1.provider是指，在短信服务器中设置的运营商，如下图：
GoIP线路必定归属于其中一个运营商。
可利用这个特点来做类似分组的功能。
（运营商名称可以自定义，例如“移动_1组”） 2.goip_line和provider都是可选的若仅指定provider，则归属于此运营商的在线GoIP线路循环发送短信；若仅指定goip_line，则选择指定的GOIP线路发送短信；若两者同时指定，则以goip_line为准，provider将被忽略；若两者都未指定，则选择全部在线GoIP线路循环发送短信。
3.单个请求中重复列出的相同接收人号码，会被合并处理，仅视为一个号码。
4.循环方式：初始状态下，所有在线的GoIP线路排队等候短信发送；一个GoIP线 路发送一条短信后，将被置于队尾。
2.2对于发送短信请求的返回 短信服务器接收到短信发送请求后，会立刻以json格式返回以下内容： 键名 描述 result 请求是否被受理。
有两种可能的情况：ACCEPT–短信服务器接受本次发送短信请求REJECT–短信服务器拒绝本次发送短信请求 taskID 任务ID。
当result为ACCEPT时，短信服务器同时给出一个全局 唯一的整数，作为本次发送短信请求的唯一标识。
reason 短信服务器拒绝发送短信请求的原因：none_line-没有任何有效的GOIP线路，或指定的线路不存在none_provider-指定的provider不存在unknown-未知原因 示例：{"result":"ACCEPT","taskID":"5689"}{"result":"REJECT","reason":"none_line"} 补充说明：短信服务器为一个发送短信请求生成“任务ID”的同时，也为请求中的每一个接收人号码生成子任务ID，其语法为：.例如某个发送短信请求的任务ID为5689，其中有一个接收人号码为，那么其对应的子任务ID为：“5689.”。
子任务ID用于状态查询和状态同步，在下面的章节中有介绍。
2.3短信任务的状态同步 短信服务器可向指定URL上报短信的发送结果。
需要制作接收此上报的接口，并将URL设置在下图位置： 当一条短信发送结束后，短信服务器立刻以post方式上报短信发送的结果，其内容为 一个json对象。
json参数： 键名 描述 taskID 此处为子任务ID，表明该短信状态对应哪一个任务中的哪一个号码 例如：3578. goip_lineGoIP线路ID，表明该短信是由哪一个GoIP线路发出的 send 发送状态，表明该短信的发送结果：eeded–发送成功failed–发送失败unsend–未发送sending–正在发送 receipt 短信发生成功后，若收到回执信息，则上报"receipt":"1" err_code短信发送失败的错误代码，参考《附录ACMSERROR》 示例：
1.短信发送失败{"taskID":"5689.","goip_line":"G101","send":"failed","err_code":"350"}
2.短信发送成功{"taskID":"5689.","goip_line":"G101","send":"eeded"}
3.短信发送成功后，收到回执信息{"taskID":"5689.","goip_line":"G101","send":"eeded","receipt":"1"} 补充说明：短信服务器不会主动上报unsend和sending状态。
此两种状态仅会在回复“querysms（查询短信任务状态请求）”时出现。
3查询短信任务状态 3.1查询短信任务状态的请求 除以上主动上报短信状态以外，短信服务器还支持第三方发起状态查询。
接口名：querysms json参数： 键名 描述 auth 必须，所有请求都必须携带的认证信息 taskID 必须，指定要查询哪一个短信任务的状态信息 可以指定一个发送短信请求的taskID，也可以指定任务中某一个号 码的子任务ID 示例：
1.指定任务ID，查询此任务中对全部接收人号码的短信发送状态 POST方式请求http:///goip/querysms/{
"auth":{"username":"登录名","password":"登录密码"},"taskID":"5689"}
2.指定子任务ID，仅查询任务中对其中一个接收人号码的短息发送状态POST方式请求http:///goip/querysms/{"auth":{"username":"登录名","password":"登录密码"},"taskID":"5689."}
3.2对于查询短信任务状态的返回
以数组形式将状态信息返回，数组的每一个元素都是一个json对象。
其参数与《2.3短信任务的状态同步》中的描述一致。
示例：[ {"taskID":"5689.","goip_line":"G101","send":"failed","err_code":"350"},{"taskID":"5689.","goip_line":"G102","send":"eeded"},{"taskID":"5689.","goip_line":"null","send":"sending"},{"taskID":"5689.","goip_line":"null","send":"unsend"},…] 补充说明：
1.即使仅查询子任务ID，也将以数组方式返回结果。
数组中仅有一个json对象
2.如果指定的taskID不存在，返回结果为“空数组” 4查询GOIP线路状态 4.1查询GOIP线路状态的请求 接口名：querylines json参数： 键名 描述 auth 必须，所有请求都必须携带的认证信息 示例： POST方式请求http:///goip/querylines/{"auth":{"username":"登录名","password":"登录密码"}}
4.2查询GOIP线路状态的返回
以数组形式将状态信息返回，数组的每一个元素都是一个json对象。
json参数： 键名 描述 goip_line GOIP的线路ID online GOIP线路是否连接到短信服务器：1–GOIP线路已连接到短信服务器0–GOIP线路未连接短信服务器 reg GOIP线路的SIM卡注册状态： LOGIN–SIM卡已注册 LOGOUT–SIM卡未注册 空–等同于LOGOUT remain_sms GOIP线路的总剩余短信数量。
整数，“-1”表示无限制 day_remain_smsGOIP线路当前的剩余短信数量。
整数，“-1”表示无限制 示例： [{"goip_line":"G101","online":"1","reg":"LOGOUT","remain_sms":"-1","day_remain_sms":"-1"},{"goip_line":"G102","online":"1","reg":"LOGIN","remain_sms":"856","day_remain_sms":"56"},{"goip_line":"G103","online":"1","reg":"","remain_sms":"-1","day_remain_sms":"-1"},{"goip_line":"G104","online":"0","reg":"","remain_sms":"-1","day_remain_sms":"-1"}, ] 补充说明：
短信服务器可设置每个GOIP线路发送短信的总数量限制和每天的数量限制。
剩余数量会体现在remain_sms和day_remain_sms这两个参数中。
5汇报收到的短信 短信服务器可向指定URL上报GOIP线路收到的短信。
需要制作接收此上报的接口，并将URL设置在下图位置： 当GOIP线路收到短信，短信服务器立刻以post方式上报此收到的短信，其内容为
一 个json对象。
json参数： 键名 描述 goip_line 接收短信的GOIP线路ID from_number短信的发送方号码 content 短信内容 recv_time 接收到短信的时间，格式为:“YYYY-MM-DDhh:mm:ss” 示例：{ "goip_line":"G101","from_number":"10086","content":"尊敬的客户，本次活动已结束，感谢您的支持！【中国移动】","recv_time":"2019-09-2615:26:05"} 附录ACMSERROR 短信发送失败后，移动通讯模块会返回错误码。
这些错误码可能来自运营商的返回或者通讯模块本身。
下面为一些错误码的参考信息：
1,"Unassigned(unallocated)number"
8,"Operatordeterminedbarring"10,"Callbarred"17,"Networkfailure"21,"Shortmessagetransferrejected"22,"Memorycapacityexceeded"27,"Destinationoutofservice"28,"Unidentifiedsubscriber"29,"Facilityrejected"30,"UnknownSubscriber"38,"Networkoutoforder"41,"Temporaryfailure"42,"Congestion"47,"Resourcesunvailable,unspecified"50,"Requestedfacilitynotsubscribed"69,"Requestedfacilitynotimplemented"81,"Invalidshortmessagereferencevalue"95,"Invalidmessage,unspecified"96,"Invalidmandatoryinformation"97,"Messagetypenon-existentornotimplemented"98,"Messagepatiblewithshortmessageprotocolstate"99,"Informationelementnon-existentornotimplemented"111,"Protocolerror,unspecified"127,"Interworkingunspecified"128,"Telematicinterworkingnotsupported"129,"Shortmessagetype0notsupported"130,"Cannotreplaceshortmessage"143,"UnspecifiedTP-PIDerror"144,"Datacodingscheme(alphabet)notsupported"145,"Messageclassnotsupported"159,"UnspecifiedTP-DCSerror"160,"Commandcannotbeactioned"161,"Commandunsupported"175,"UnspecifiedTP-Commanderror"176,"TPDUnotsupported"192,"SCbusy" 193,"NoSCsubscription"194,"SCsystemfailure"195,"InvalidSMEaddress"196,"DestinationSMEbarred"197,"SMRejected-DuplicateSM"198,"TP-VPFnotsupported"199,"TP-VPnotsupported"208,"SIMSMSstoragefull"209,"NoSMSstoragecapabilityinSIM"210,"ErrorinMS"211,"MemoryCapacityExceeded"212,"SIMApplicationToolkitBusy"213,"SIMdatadownloaderror"224,"TP_FCS_APPL_ERR_START"254,"TP_FCS_APPL_ERR_STOP"255,"TP_FCS_UNSPECIFIED"300,"MEfailure"301,"SMSserviceofMEreserved"302,"operationnotallowed"303,"operationnotsupported"305,"invalidtextmodeparameter"312,"PH-SIMPINnecessary"310,"SIMnotinserted"311,"SIMPINrequired"312,"SIMPUKrequired"313,"SIMfailure"314,"SIMbusy"315,"SIMwrong"317,"SIMPIN2required"318,"SIMPUK2required"319,"incorrectPUK1"320,"memoryfailure"321,"invalidmemoryindex"322,"memoryfull"330,"SMSCaddressunknown"331,"workservice"332,worktimeout"340,"no+CNMAacknowledgementexpected"512,"MN_SMS_RP_ACK"513,"MN_SMS_TIMER_EXPIRED" 514,"MN_SMS_FORW_AVAIL_FAILED"515,"MN_SMS_FORW_AVAIL_ABORTED"516,"MSinvalidTP-Message-Type-Indicator"517,"MSnoTP-Status-ReportinPhase1"518,"MSnoTP-Reject-DuplicateinPhase1"519,"MSnoTP-Reply-PathinPhase1"520,"MSnoTP-User-Data-HeaderinPhase1"521,"MSmissingTP-Validity-Period"522,"MSinvalidTP-Service-Centre-Time-Stamp"523,"MSmissingTP-Destination-Address"524,"MSinvalidTP-Destination-Address"525,"MSmissingService-Centre-Address"526,"MSinvalidService-Centre-Address"527,"MSinvalidalphabet"528,"MSinvalidTP-User-Data-Length"529,"MSmissingTP-User-Data"530,"MSTP-User-Datatoolong"531,"MSnoCommand-RequestinPhase1"532,"MSCmd-ReqinvalidTP-Destination-Address"533,"MSCmd-ReqinvalidTP-User-Data-Length"534,"MSCmd-ReqinvalidTP-User-Data"535,"MSCmd-ReqinvalidTP-Command-Type"536,"MNMNRcreationfailed"537,"MSCMMcreationfailed"538,"workconnectionlost"539,"MSpendingMOSMtransfer"540,"RP-ErrorOK"541,"RP-ErrorOKnoicondisplay"542,"SMS-PPUnspecified"543,"SMSrejectedBySMSCONTROL"
简单示意图如下： 本接口采用http+json结合的方式。
基本格式如下：以post方式请求： http://
1.【"auth":{"username":"登录名","password":"登录密码"}】，任何一请求都必须携带短 信服务器的登录认证信息。
若不携带，或登录名/密码错误，则服务器将返回
401错误。
2.<接口名>是指不同功能的入口：sendsms，发送短信querysms，查询短信的发送状态querylines，查询全部GoIP线路的状态
3.请求URL中，末尾的“/”字符不可省略
4.数据编码全部采用UTF-
8 2发送短信 2.1发送短信请求 接口名：sendsms json参数： 键名 描述 auth 必须，所有请求都必须携带的认证信息 provider 可选，指定归属于某个运营商的GOIP线路发送短信 goip_line 可选，指定某个GOIP线路发送短信 number 必须，指定接收人号码；可用“,”隔开提交多个号码(上限9999个) content 必须，指定要发送的短信内容 示例： 使用归属于运营商【移动】的GOIP线路，给号码、、 发送短信，内容为“测试”。
POST方式请求http://
可利用这个特点来做类似分组的功能。
（运营商名称可以自定义，例如“移动_1组”） 2.goip_line和provider都是可选的若仅指定provider，则归属于此运营商的在线GoIP线路循环发送短信；若仅指定goip_line，则选择指定的GOIP线路发送短信；若两者同时指定，则以goip_line为准，provider将被忽略；若两者都未指定，则选择全部在线GoIP线路循环发送短信。
3.单个请求中重复列出的相同接收人号码，会被合并处理，仅视为一个号码。
4.循环方式：初始状态下，所有在线的GoIP线路排队等候短信发送；一个GoIP线 路发送一条短信后，将被置于队尾。
2.2对于发送短信请求的返回 短信服务器接收到短信发送请求后，会立刻以json格式返回以下内容： 键名 描述 result 请求是否被受理。
有两种可能的情况：ACCEPT–短信服务器接受本次发送短信请求REJECT–短信服务器拒绝本次发送短信请求 taskID 任务ID。
当result为ACCEPT时，短信服务器同时给出一个全局 唯一的整数，作为本次发送短信请求的唯一标识。
reason 短信服务器拒绝发送短信请求的原因：none_line-没有任何有效的GOIP线路，或指定的线路不存在none_provider-指定的provider不存在unknown-未知原因 示例：{"result":"ACCEPT","taskID":"5689"}{"result":"REJECT","reason":"none_line"} 补充说明：短信服务器为一个发送短信请求生成“任务ID”的同时，也为请求中的每一个接收人号码生成子任务ID，其语法为：
子任务ID用于状态查询和状态同步，在下面的章节中有介绍。
2.3短信任务的状态同步 短信服务器可向指定URL上报短信的发送结果。
需要制作接收此上报的接口，并将URL设置在下图位置： 当一条短信发送结束后，短信服务器立刻以post方式上报短信发送的结果，其内容为 一个json对象。
json参数： 键名 描述 taskID 此处为子任务ID，表明该短信状态对应哪一个任务中的哪一个号码 例如：3578. goip_lineGoIP线路ID，表明该短信是由哪一个GoIP线路发出的 send 发送状态，表明该短信的发送结果：eeded–发送成功failed–发送失败unsend–未发送sending–正在发送 receipt 短信发生成功后，若收到回执信息，则上报"receipt":"1" err_code短信发送失败的错误代码，参考《附录ACMSERROR》 示例：
1.短信发送失败{"taskID":"5689.","goip_line":"G101","send":"failed","err_code":"350"}
2.短信发送成功{"taskID":"5689.","goip_line":"G101","send":"eeded"}
3.短信发送成功后，收到回执信息{"taskID":"5689.","goip_line":"G101","send":"eeded","receipt":"1"} 补充说明：短信服务器不会主动上报unsend和sending状态。
此两种状态仅会在回复“querysms（查询短信任务状态请求）”时出现。
3查询短信任务状态 3.1查询短信任务状态的请求 除以上主动上报短信状态以外，短信服务器还支持第三方发起状态查询。
接口名：querysms json参数： 键名 描述 auth 必须，所有请求都必须携带的认证信息 taskID 必须，指定要查询哪一个短信任务的状态信息 可以指定一个发送短信请求的taskID，也可以指定任务中某一个号 码的子任务ID 示例：
1.指定任务ID，查询此任务中对全部接收人号码的短信发送状态 POST方式请求http://
2.指定子任务ID，仅查询任务中对其中一个接收人号码的短息发送状态POST方式请求http://
其参数与《2.3短信任务的状态同步》中的描述一致。
示例：[ {"taskID":"5689.","goip_line":"G101","send":"failed","err_code":"350"},{"taskID":"5689.","goip_line":"G102","send":"eeded"},{"taskID":"5689.","goip_line":"null","send":"sending"},{"taskID":"5689.","goip_line":"null","send":"unsend"},…] 补充说明：
1.即使仅查询子任务ID，也将以数组方式返回结果。
数组中仅有一个json对象
2.如果指定的taskID不存在，返回结果为“空数组” 4查询GOIP线路状态 4.1查询GOIP线路状态的请求 接口名：querylines json参数： 键名 描述 auth 必须，所有请求都必须携带的认证信息 示例： POST方式请求http://
json参数： 键名 描述 goip_line GOIP的线路ID online GOIP线路是否连接到短信服务器：1–GOIP线路已连接到短信服务器0–GOIP线路未连接短信服务器 reg GOIP线路的SIM卡注册状态： LOGIN–SIM卡已注册 LOGOUT–SIM卡未注册 空–等同于LOGOUT remain_sms GOIP线路的总剩余短信数量。
整数，“-1”表示无限制 day_remain_smsGOIP线路当前的剩余短信数量。
整数，“-1”表示无限制 示例： [{"goip_line":"G101","online":"1","reg":"LOGOUT","remain_sms":"-1","day_remain_sms":"-1"},{"goip_line":"G102","online":"1","reg":"LOGIN","remain_sms":"856","day_remain_sms":"56"},{"goip_line":"G103","online":"1","reg":"","remain_sms":"-1","day_remain_sms":"-1"},{"goip_line":"G104","online":"0","reg":"","remain_sms":"-1","day_remain_sms":"-1"}, ] 补充说明：
短信服务器可设置每个GOIP线路发送短信的总数量限制和每天的数量限制。
剩余数量会体现在remain_sms和day_remain_sms这两个参数中。
5汇报收到的短信 短信服务器可向指定URL上报GOIP线路收到的短信。
需要制作接收此上报的接口，并将URL设置在下图位置： 当GOIP线路收到短信，短信服务器立刻以post方式上报此收到的短信，其内容为
一 个json对象。
json参数： 键名 描述 goip_line 接收短信的GOIP线路ID from_number短信的发送方号码 content 短信内容 recv_time 接收到短信的时间，格式为:“YYYY-MM-DDhh:mm:ss” 示例：{ "goip_line":"G101","from_number":"10086","content":"尊敬的客户，本次活动已结束，感谢您的支持！【中国移动】","recv_time":"2019-09-2615:26:05"} 附录ACMSERROR 短信发送失败后，移动通讯模块会返回错误码。
这些错误码可能来自运营商的返回或者通讯模块本身。
下面为一些错误码的参考信息：
1,"Unassigned(unallocated)number"
8,"Operatordeterminedbarring"10,"Callbarred"17,"Networkfailure"21,"Shortmessagetransferrejected"22,"Memorycapacityexceeded"27,"Destinationoutofservice"28,"Unidentifiedsubscriber"29,"Facilityrejected"30,"UnknownSubscriber"38,"Networkoutoforder"41,"Temporaryfailure"42,"Congestion"47,"Resourcesunvailable,unspecified"50,"Requestedfacilitynotsubscribed"69,"Requestedfacilitynotimplemented"81,"Invalidshortmessagereferencevalue"95,"Invalidmessage,unspecified"96,"Invalidmandatoryinformation"97,"Messagetypenon-existentornotimplemented"98,"Messagepatiblewithshortmessageprotocolstate"99,"Informationelementnon-existentornotimplemented"111,"Protocolerror,unspecified"127,"Interworkingunspecified"128,"Telematicinterworkingnotsupported"129,"Shortmessagetype0notsupported"130,"Cannotreplaceshortmessage"143,"UnspecifiedTP-PIDerror"144,"Datacodingscheme(alphabet)notsupported"145,"Messageclassnotsupported"159,"UnspecifiedTP-DCSerror"160,"Commandcannotbeactioned"161,"Commandunsupported"175,"UnspecifiedTP-Commanderror"176,"TPDUnotsupported"192,"SCbusy" 193,"NoSCsubscription"194,"SCsystemfailure"195,"InvalidSMEaddress"196,"DestinationSMEbarred"197,"SMRejected-DuplicateSM"198,"TP-VPFnotsupported"199,"TP-VPnotsupported"208,"SIMSMSstoragefull"209,"NoSMSstoragecapabilityinSIM"210,"ErrorinMS"211,"MemoryCapacityExceeded"212,"SIMApplicationToolkitBusy"213,"SIMdatadownloaderror"224,"TP_FCS_APPL_ERR_START"254,"TP_FCS_APPL_ERR_STOP"255,"TP_FCS_UNSPECIFIED"300,"MEfailure"301,"SMSserviceofMEreserved"302,"operationnotallowed"303,"operationnotsupported"305,"invalidtextmodeparameter"312,"PH-SIMPINnecessary"310,"SIMnotinserted"311,"SIMPINrequired"312,"SIMPUKrequired"313,"SIMfailure"314,"SIMbusy"315,"SIMwrong"317,"SIMPIN2required"318,"SIMPUK2required"319,"incorrectPUK1"320,"memoryfailure"321,"invalidmemoryindex"322,"memoryfull"330,"SMSCaddressunknown"331,"workservice"332,worktimeout"340,"no+CNMAacknowledgementexpected"512,"MN_SMS_RP_ACK"513,"MN_SMS_TIMER_EXPIRED" 514,"MN_SMS_FORW_AVAIL_FAILED"515,"MN_SMS_FORW_AVAIL_ABORTED"516,"MSinvalidTP-Message-Type-Indicator"517,"MSnoTP-Status-ReportinPhase1"518,"MSnoTP-Reject-DuplicateinPhase1"519,"MSnoTP-Reply-PathinPhase1"520,"MSnoTP-User-Data-HeaderinPhase1"521,"MSmissingTP-Validity-Period"522,"MSinvalidTP-Service-Centre-Time-Stamp"523,"MSmissingTP-Destination-Address"524,"MSinvalidTP-Destination-Address"525,"MSmissingService-Centre-Address"526,"MSinvalidService-Centre-Address"527,"MSinvalidalphabet"528,"MSinvalidTP-User-Data-Length"529,"MSmissingTP-User-Data"530,"MSTP-User-Datatoolong"531,"MSnoCommand-RequestinPhase1"532,"MSCmd-ReqinvalidTP-Destination-Address"533,"MSCmd-ReqinvalidTP-User-Data-Length"534,"MSCmd-ReqinvalidTP-User-Data"535,"MSCmd-ReqinvalidTP-Command-Type"536,"MNMNRcreationfailed"537,"MSCMMcreationfailed"538,"workconnectionlost"539,"MSpendingMOSMtransfer"540,"RP-ErrorOK"541,"RP-ErrorOKnoicondisplay"542,"SMS-PPUnspecified"543,"SMSrejectedBySMSCONTROL"
声明：
该资讯来自于互联网网友发布，如有侵犯您的权益请联系我们。