Interface Description Document

<p class="shortdesc"></p> <p class="p"><strong class="ph b">1. Overview</strong></p> <p class="p"><strong class="ph b">1.1 Interface Message Protocol Convention</strong></p> <p class="p">Interfaces in the system <strong class="ph b">adopt the data transmission method of HTTPS plus JSON</strong> by default. For more information, see protocol description of the specific interfaces.</p> <p class="p"><strong class="ph b">2. Public Request URL and Processing</strong></p> <p class="p"><strong class="ph b">2.1 Request URLs</strong></p> <table class="table" id="Interface_Documentation__table_cnr_gg5_xmb"><caption></caption><colgroup><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_cnr_gg5_xmb__entry__1">Environment</th> <th class="entry" id="Interface_Documentation__table_cnr_gg5_xmb__entry__2">HTTP</th> <th class="entry" id="Interface_Documentation__table_cnr_gg5_xmb__entry__3">HTTPS</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_cnr_gg5_xmb__entry__1 "> <p class="p">Production</p> </td> <td class="entry" headers="Interface_Documentation__table_cnr_gg5_xmb__entry__2 "> <p class="p">http://api.xiaoxi.pingan.com.cn/rest/{type}</p> </td> <td class="entry" headers="Interface_Documentation__table_cnr_gg5_xmb__entry__3 "> <p class="p">https://api.xiaoxi.pingan.com.cn/rest/{type}</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_cnr_gg5_xmb__entry__1 "> <p class="p">Test</p> </td> <td class="entry" headers="Interface_Documentation__table_cnr_gg5_xmb__entry__2 "> <p class="p">http://apitest.xiaoxi.pingan.com.cn/rest/{type}</p> </td> <td class="entry" headers="Interface_Documentation__table_cnr_gg5_xmb__entry__3 "> <p class="p">https://apitest.xiaoxi.pingan.com.cn/rest/{type}</p> </td> </tr> </tbody></table> <div class="p"> <div class="note note note_note"><span class="note__title">Note:</span> <em class="ph i">The type is API type. For example, related message is msg. We recommend that you send messages that have high demand for data security with HTTPS.</em></div> </div> <p class="p"><strong class="ph b">2.2 Public Request Parameters</strong></p> <table class="table" id="Interface_Documentation__table_dnr_gg5_xmb"><caption></caption><colgroup><col><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_dnr_gg5_xmb__entry__1">Name</th> <th class="entry" id="Interface_Documentation__table_dnr_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_dnr_gg5_xmb__entry__3">Default</th> <th class="entry" id="Interface_Documentation__table_dnr_gg5_xmb__entry__4">Example value</th> <th class="entry" id="Interface_Documentation__table_dnr_gg5_xmb__entry__5">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__1 "> <p class="p">method</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__3 "> <p class="p">Required</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__4 "></td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__5 "> <div class="p">API method name.<ul class="ul" id="Interface_Documentation__ul_enr_gg5_xmb"> <li class="li">sendsms (send short messages)</li> <li class="li">querySmsResult (query results of the sent short messages)</li> <li class="li">fetchNewSms (query results of the MO short messages)</li> </ul></div> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__1 "> <p class="p">appid</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__3 "> <p class="p">Required</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__4 "> <p class="p">123</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__5 "> <p class="p">An application ID applied at the Message Cloud platform.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__1 "> <p class="p">timestamp</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__3 "> <p class="p">Required</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__4 ">20170315120000</td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__5 "> <p class="p">yyyyMMddHHmmss</p> <p class="p">The value is valid within 30 minutes and can be unchanged during the term of validity, which means that the signature is the same. The default field is the current time of the system when you call an API.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__1 "> <p class="p">sign</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__3 "> <p class="p">Required</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__4 "></td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__5 "> <p class="p">Make the MD5 signature for appid+timestamp+secre with secre as the key pair. Transcribe the signed MD5 character strings into uppercase characters.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__1 "> <p class="p">extend</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__3 "> <p class="p">Optional</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__4 "> <p class="p">123456</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__5 "> <p class="p">A public return parameter that will be passed through in the message return. For example, users can input their order IDs. The order numbers will be returned with the message. Users can identify the short messages and their corresponding orders based on the order IDs.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__1 "> <p class="p">version</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__3 "> <p class="p">Optional</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__4 "> <p class="p">1.0</p> </td> <td class="entry" headers="Interface_Documentation__table_dnr_gg5_xmb__entry__5 "> <p class="p">The current API version. You do not need to enter anything by default.</p> </td> </tr> </tbody></table> <div class="p"> <div class="note note note_note"><span class="note__title">Note:</span> <p class="p">The following is the public application ID and secret in the testing environment. You can use them for testing in the development and debugging phase. In the product go-live phase, you need to use the actual ID and secret.</p> <p class="p">appid: 680BB7E2B5F04F54E0537CE21F0A1D88</p> <p class="p">secret: 6A43C3D60BC8ACBFC1D548E57ED7AFE4</p> </div> </div> <p class="p"><strong class="ph b">2.3 Public Response Parameters</strong></p> <table class="table" id="Interface_Documentation__table_fnr_gg5_xmb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_fnr_gg5_xmb__entry__1">Name</th> <th class="entry" id="Interface_Documentation__table_fnr_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_fnr_gg5_xmb__entry__3">Example</th> <th class="entry" id="Interface_Documentation__table_fnr_gg5_xmb__entry__4">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__1 "> <p class="p">code</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__3 "> <p class="p">000000</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__4 "> <p class="p">Return code. If the return code is not 000000, it indicates an abnormal request. Users can process the abnormal request as demanded.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__1 "> <p class="p">msg</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__3 "> <p class="p">Successful.</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__4 "> <p class="p">Return information description.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__1 "> <p class="p">appid</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__4 "> <p class="p">Application ID.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__1 "> <p class="p">extend</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__4 "> <p class="p">Public return parameter.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__1 "> <p class="p">expiretime</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__3 "> <p class="p">20170315123000</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__4 "> <p class="p">Expiration time of signature.</p> <p class="p">yyyyMMddHHmmss</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__1 "> <p class="p">token</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_fnr_gg5_xmb__entry__4 "> <p class="p">New signature.</p> </td> </tr> </tbody></table> <ul class="ul" id="Interface_Documentation__ul_gnr_gg5_xmb"> <li class="li"><strong class="ph b">Signature Algorithm</strong></li> </ul> <p class="p">To avoid illegally calling an API, you need a signature for calling any API. The API server will verify the signature based on the request parameter and reject the request with illegal signature. The general signature procedure is shown as follows:</p> <ul class="ul" id="Interface_Documentation__ul_hnr_gg5_xmb"> <li class="li">Piece together the value of appid, timestamp, and secre and conduct MD5 signature. Transcribe the MD5 character strings into uppercase letters.</li> <li class="li">For example, appid=123, timestamp=20170315120000, and secret=xxx.</li> <li class="li">They can be transcribed into 12320170315120000xxx.</li> <li class="li">Encode the integrated character strings in the form of utf-8. Extract the encoded byte stream with the signature algorithm.</li> </ul> <div class="p"> <div class="note note note_note"><span class="note__title">Note:</span> Secre refers to the application secret used in applying for the application ID at the Message Cloud platform.</div> </div> <ul class="ul" id="Interface_Documentation__ul_inr_gg5_xmb"> <li class="li"><strong class="ph b">Signature Verification Procedures</strong></li> </ul> <p class="p">The following example simulates that a user initiates a request for sending messages to interact with the Message Cloud platform.</p> <p class="p">(1) A third-party application initiates a HTTPS request with appid, timestamp, and sign.</p> <p class="p">(2) If the signature is verified to be correct at the Message Cloud platform, you will enter the message sending procedure in which the system will generate a token, define the value of expiretime and return such information to the third-party application.</p> <p class="p">(3) If the signature is verified to be wrong at the Message Cloud platform, the system will return the information of wrong signature to the third-party application. </p> <p class="p">(4) The third-party application initiates a HTTPS request for the second time. If the signature is verified and includes a token within the term of validity, it is not required to resign again.</p> <p class="p">(5) Send the request with the token. For example:</p> <p class="p">appid=xxx&timestamp=xxx&sign=token.</p> <p class="p">(6) Enter the message sending process after the Message Cloud platform verifies that the token is correct and within the term of validity. If the system cannot find the token or the token is invalid, it will verify the signature again. If the signature is incorrect, the system will return the error information.</p> <p class="p"><strong class="ph b">3. Send Short Messages</strong></p> <ul class="ul" id="Interface_Documentation__ul_knr_gg5_xmb"> <li class="li"><strong class="ph b">Scenario Description</strong></li> </ul> <p class="p">The platform will send short messages to the designated mobile phone number. You can configure some variables in the template. You need to obtain the short message signature and template before sending a short message. You can use the HTTPS request URLs of the formal environment in testing. Messages sent in a batch may be delayed (for example, sending a message to multiple mobile phone numbers such as 1881111111 and 1882222222). We recommend that you send one message each time if you have higher demand for the timeliness of the message.</p> <ul class="ul" id="Interface_Documentation__ul_lnr_gg5_xmb"> <li class="li"><strong class="ph b">Interface Message Name</strong></li> </ul> <p class="p">Interface URL: https://api.xiaoxi.pingan.com.cn/rest/msg.</p> <p class="p">Method: sendsms</p> <p class="p">Initiator: Related system</p> <p class="p">Receiver: Message Cloud platform</p> <p class="p">Type of message sending: <strong class="ph b">POST</strong></p> <p class="p"><strong class="ph b">3.1 Request Parameters</strong></p> <table class="table" id="Interface_Documentation__table_mnr_gg5_xmb"><caption></caption><colgroup><col><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_mnr_gg5_xmb__entry__1">Attribute</th> <th class="entry" id="Interface_Documentation__table_mnr_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_mnr_gg5_xmb__entry__3">Default</th> <th class="entry" id="Interface_Documentation__table_mnr_gg5_xmb__entry__4">Example value</th> <th class="entry" id="Interface_Documentation__table_mnr_gg5_xmb__entry__5">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">sendType</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Optional</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "> <p class="p">0</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">0 (short message notification): Notification SMS refers to sending all kinds of notifications in the form of short messages to mobile phone numbers contracted by users. </p> <p class="p">1 (OTP short message verification code): Send a set of digital verification codes in the form of short messages to the mobile phone numbers contracted by users. Users need to enter the verification code to verify their legal identities.</p> <p class="p">2 (international short message): Send short messages to mobile phone numbers registered in regions outside Chinese mainland including Hong Kong, Macao, Taiwan, and other foreign countries and regions.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">templateId</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Required</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "> <p class="p">pscp_demo</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">Use the template ID that is registered at the Message Cloud platform. The attribute must be filled in.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">requestId</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Required</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "> <p class="p">111,222</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">The unique ID of a short message in the system in one day. The request ID must be a positive integer with a maximum of 19 digits which cannot begin with zero or cannot be replicated in one day. We recommend that the request ID is the primary key of the short message table of the related system. Short messages with the same request ID in one day will be considered as repeated submission and will not be sent.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">mobileNo</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Required</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "> <p class="p">13480323810,13480323810</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">The mobile phone number must be of 11 digits. Multiple mobile phone numbers are supported and should be separated with English commas.</p> <div class="p"> <div class="note note note_note"><span class="note__title">Note:</span> A maximum of 200 mobile phone numbers are supported for each request.</div> </div> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">paramKeys</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Optional</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "> <p class="p">name,amount</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">Names of the template variables should be separated by English commas. If the template has variables or values of paramValues, this parameter must be filled in.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">paramValues</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">Json array</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Optional</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "> <p class="p">1. [[“Person A”,”100”]], [[“Person B”,”1000”]]</p> <p class="p">2. [“Person C”,”2000”]</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">Values of the template variables form an array in the format of json. The number of the variable values must have one-to-one correspondence to the number of paramKey. The array of the variable values must have one-to-one correspondence to the number of mobileNo. If there is only one array of the variable values, the variable values of all mobile phone numbers are considered to be the same by default.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">serviceID</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Optional</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "> <p class="p">123</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">Service ID, which can be used to distinguish different interactive businesses (the maximum length of the service ID is three digits).</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">arrangeDate</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Optional</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "></td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">The arranged sending time of a short message. If the parameter is not filled in, the short message will be sent immediately. Format: yyyyMMddHHmmss</p> <div class="note note note_note"><span class="note__title">Note:</span> This parameter is of string type when it is transferred. The short message will be sent subsequently at the arranged sending time. The specific sending time is determined by the total deliveries of the platform at that time.</div> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__1 "> <p class="p">expireDate</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__3 "> <p class="p">Optional</p> </td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__4 "></td> <td class="entry" headers="Interface_Documentation__table_mnr_gg5_xmb__entry__5 "> <p class="p">Expiration time, after which the short messages will not be sent. If the field is not filled in, there is no expiration time for the short messages.</p> <p class="p">Format: yyyyMMddHHmmss</p> <div class="note note note_note"><span class="note__title">Note:</span> This parameter is of String type when it is transferred.</div> </td> </tr> </tbody></table> <div class="p"> <div class="note note note_note"><span class="note__title">Note:</span> The following is the public short message template and variables in testing environment. You can use them in the development and debugging phase, but must replace them with actual short message template and variables in the product go-live phase. The following template only has one global variable, so upload the sms_content variable for sending short message content. For example:</div> </div> <table class="table" id="Interface_Documentation__table_nnr_gg5_xmb"><caption></caption><colgroup><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_nnr_gg5_xmb__entry__1">Template No.</th> <th class="entry" id="Interface_Documentation__table_nnr_gg5_xmb__entry__2">Variable</th> <th class="entry" id="Interface_Documentation__table_nnr_gg5_xmb__entry__3">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__1 "> <p class="p">otp_00000005685</p> </td> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__2 "> <p class="p">code</p> </td> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__3 "> <p class="p">Transaction short messages</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__1 "> <p class="p">fwm_00000005686</p> </td> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__2 "> <p class="p">sms_content</p> </td> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__3 "> <p class="p">Service short messages</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__1 "> <p class="p">yxm_00000005687</p> </td> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__2 "> <p class="p">sms_content</p> </td> <td class="entry" headers="Interface_Documentation__table_nnr_gg5_xmb__entry__3 "> <p class="p">Marketing short messages</p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">3.3 Response Parameters</strong></p> <table class="table" id="Interface_Documentation__table_onr_gg5_xmb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_onr_gg5_xmb__entry__1">Name</th> <th class="entry" id="Interface_Documentation__table_onr_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_onr_gg5_xmb__entry__3">Example</th> <th class="entry" id="Interface_Documentation__table_onr_gg5_xmb__entry__4">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__1 "> <p class="p">Public response parameters</p> </td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__2 "></td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__4 "> <p class="p">For more information about detailed definitions, see Public Response Parameters.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__1 "> <p class="p">successList</p> </td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__2 "> <p class="p">List</p> </td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__4 "> <p class="p">Records of successful processing. Each object in the successList is a Json object. The following table describes its attributes.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__1 "> <p class="p">failList</p> </td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__2 "> <p class="p">List</p> </td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_onr_gg5_xmb__entry__4 "> <p class="p">Records of failed processing. Each object in the failList is a Jason object. The following table describes its attributes.</p> </td> </tr> </tbody></table> <p class="p">Attributes of successList and failList.</p> <table class="table" id="Interface_Documentation__table_pnr_gg5_xmb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_pnr_gg5_xmb__entry__1">Attribute</th> <th class="entry" id="Interface_Documentation__table_pnr_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_pnr_gg5_xmb__entry__3">Example</th> <th class="entry" id="Interface_Documentation__table_pnr_gg5_xmb__entry__4">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__1 "> <p class="p">requestID</p> </td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__4 "> <p class="p">A request ID defined by the sender. For more information, see Request Parameters.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__1 "> <p class="p">messageID</p> </td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__4 "> <p class="p">The unique ID of a message received by the short message platform. The return value is -1 if an error occurs.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__1 "> <p class="p">code</p> </td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__3 ">0</td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__4 "> <p class="p">A result ID. The return value is zero if the operation is successful. Otherwise, the return value is not zero.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__1 "> <p class="p">msg</p> </td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_pnr_gg5_xmb__entry__4 "> <p class="p">A result description. The return value is yes if the operation is successful.</p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">3.3 Request Example</strong></p> <p class="p">https://apitest.xiaoxi.pingan.com.cn/rest/msg?method=sendsms&appid=52FC69100A311528E0537CE21F0A7CE9&timestamp=20170630161054&sign=E0AA7BF266B9BADFF436D62A2D227A88&templateId=fwm_00000000722&paramKeys=sms_content&paramValues=["content of the short message"]&mobileNo=18820222220&requestId=1000&extend=this is an extended filed&version=1.0</p> <p class="p"><strong class="ph b">Realize with SDK of Java version</strong></p> <table class="table" id="Interface_Documentation__table_qnr_gg5_xmb"><caption></caption><colgroup><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <ul class="ul" id="Interface_Documentation__ul_rnr_gg5_xmb"> <li class="li"> <strong class="ph b">Create and send a short message to a client. Enter URL, application ID, and secret.</strong></li> </ul> <p class="p">MSGOMCPClient msgomcpClient = new MSGOMCPClient("http://apitest.xiaoxi.pingan.com.cn/rest", "52FC69100A311528E0537CE21F0A7CE9", " E0AA7BF266B9BADFF436D62A2D227A88");</p> <ul class="ul" id="Interface_Documentation__ul_snr_gg5_xmb"> <li class="li"><strong class="ph b">Configure content to be sent, template, request ID, mobile phone number, variables, and extended field.</strong></li> </ul> <p class="p">SmsSendContent smsSendContent = new SmsSendContent("fwm_00000000722");</p> <p class="p">smsSendContent.setRequestId("201704201512000");</p> <p class="p">smsSendContent.setMobileNo("18820222220");</p> <p class="p">smsSendContent.setParamKeys("sms_content"});</p> <p class="p">smsSendContent.setParamValues("content of the short message");</p> <p class="p">smsSendContent.setExtend("it is an extended field");</p> <ul class="ul" id="Interface_Documentation__ul_tnr_gg5_xmb"> <li class="li"><strong class="ph b">Send a short message</strong></li> </ul> <p class="p">SmsSendResult result = msgomcpClient.sendsms(smsSendContent);</p> <p class="p">System.out.println(JSONObject.fromObject(result));</p> </td> </tr> </tbody></table> <ul class="ul" id="Interface_Documentation__ul_unr_gg5_xmb"> <li class="li"><strong class="ph b">Response Example </strong>(Return Json Format)</li> </ul> <p class="p">{</p> <p class="p"> "code": "000000",</p> <p class="p"> "msg": "successful",</p> <p class="p"> "appid": "52FC69100A311528E0537CE21F0A7CE9",</p> <p class="p"> "extend": "this is an extended field",</p> <p class="p"> "expiretime": "20170630164054",</p> <p class="p"> "token": "E0AA7BF266B9BADFF436D62A2D227A88",</p> <p class="p"> "failList": [],</p> <p class="p"> "successList": [</p> <p class="p"> {</p> <p class="p"> "code": "0",</p> <p class="p"> "msg": "",</p> <p class="p"> "requestID": "1000",</p> <p class="p"> "messageID": "2002790572"</p> <p class="p"> }</p> <p class="p"> ]</p> <p class="p">}</p> <ul class="ul" id="Interface_Documentation__ul_vnr_gg5_xmb"> <li class="li"><strong class="ph b">Exception Example</strong> (Return Json Format)</li> </ul> <p class="p">{</p> <p class="p"> "code": "000000",</p> <p class="p"> "msg": "successful",</p> <p class="p"> "appid": "52FC69100A311528E0537CE21F0A7CE9",</p> <p class="p"> "extend": "this is an extended field",</p> <p class="p"> "expiretime": "20170630164054",</p> <p class="p"> "token": "E0AA7BF266B9BADFF436D62A2D227A88",</p> <p class="p"> "failList": [</p> <p class="p"> {</p> <p class="p"> "code": "1022",</p> <p class="p"> "msg": "the mobile phone number does not have a corresponded ISP",</p> <p class="p"> "requestID": "1000",</p> <p class="p"> "messageID": "-1"</p> <p class="p"> }</p> <p class="p"> ],</p> <p class="p"> "successList": []</p> <p class="p">}</p> <p class="p"><strong class="ph b">4. Query Short Message Sending Result</strong></p> <ul class="ul" id="Interface_Documentation__ul_wnr_gg5_xmb"> <li class="li"><strong class="ph b">Scenario Description</strong></li> </ul> <p class="p">Query the short message sending result and return the short message sending results that are not queried. A maximum of 1000 items of records will be returned each time. </p> <ul class="ul" id="Interface_Documentation__ul_xnr_gg5_xmb"> <li class="li"><strong class="ph b">Interface Message Name</strong></li> </ul> <p class="p">Interface URL: https://api.xiaoxi.pingan.com.cn/rest/msg</p> <p class="p">Method: querySmsResult</p> <p class="p">Initiator: Related system</p> <p class="p">Receiver: Message Cloud platform</p> <p class="p">Type of message sending: <strong class="ph b">POST</strong></p> <p class="p"><strong class="ph b">4.1 Request Parameters</strong></p> <p class="p">Null</p> <p class="p"><strong class="ph b">4.2 Response Parameters</strong></p> <table class="table" id="Interface_Documentation__table_ynr_gg5_xmb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_ynr_gg5_xmb__entry__1">Name</th> <th class="entry" id="Interface_Documentation__table_ynr_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_ynr_gg5_xmb__entry__3">Example</th> <th class="entry" id="Interface_Documentation__table_ynr_gg5_xmb__entry__4">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_ynr_gg5_xmb__entry__1 "> <p class="p">Public response parameter</p> </td> <td class="entry" headers="Interface_Documentation__table_ynr_gg5_xmb__entry__2 "></td> <td class="entry" headers="Interface_Documentation__table_ynr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_ynr_gg5_xmb__entry__4 "> <p class="p">For more information about detailed definitions, see Public Response Parameters.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_ynr_gg5_xmb__entry__1 "> <p class="p">results</p> </td> <td class="entry" headers="Interface_Documentation__table_ynr_gg5_xmb__entry__2 "> <p class="p">List</p> </td> <td class="entry" headers="Interface_Documentation__table_ynr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_ynr_gg5_xmb__entry__4 "> <p class="p">Each object in the results is a Jason object. The following table describes its attributes.</p> </td> </tr> </tbody></table> <p class="p">Results attribute</p> <table class="table" id="Interface_Documentation__table_znr_gg5_xmb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_znr_gg5_xmb__entry__1">Attribute</th> <th class="entry" id="Interface_Documentation__table_znr_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_znr_gg5_xmb__entry__3">Example</th> <th class="entry" id="Interface_Documentation__table_znr_gg5_xmb__entry__4">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__1 "> <p class="p">RequestID</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__4 "> <p class="p">The ID of business system request.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__1 "> <p class="p">MessageID</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__4 "> <p class="p">The unique ID of a message received by the short message platform.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__1 "> <p class="p">ReportTime</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__4 "> <p class="p">Time when the report is received.</p> <p class="p">The short message platform has transferred the date format of yyyyMMddHHmmss into the string type when the value is returned.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__1 "> <p class="p">ReportResultID</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__4 "> <p class="p">The report result ID. Zero refers to success and non-zero refers to failure.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__1 "> <p class="p">ReportResultDescription</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__4 "> <p class="p">The report result description.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__1 "> <p class="p">TotalNumber</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_znr_gg5_xmb__entry__4 "> <p class="p">A short message is split into multiple ones because its content exceeds the maximum length of characters. This field refers to the number of split short messages. The return value 1 indicates that the short message is not split.</p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">4.3 Request Example</strong></p> <p class="p">https://api.xiaoxi.pingan.com.cn/rest/msg?method=querySmsResult&appid=52FC69100A311528E0537CE21F0A7CE9&timestamp=20170420151201&sign=FF15310D72A2B89AF16CB666B1838089&version=1.0</p> <p class="p"><strong class="ph b">Realize with SDK of Java version</strong></p> <table class="table" id="Interface_Documentation__table_a4r_gg5_xmb"><caption></caption><colgroup><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <ul class="ul" id="Interface_Documentation__ul_b4r_gg5_xmb"> <li class="li"><strong class="ph b">Create and send a short message to a client. Enter URL, application ID, and secret.</strong></li> </ul> <p class="p">MSGOMCPClient msgomcpClient = new MSGOMCPClient("https:// api.xiaoxi.pingan.com.cn/rest","52FC69100A311528E0537CE21F0A7CE9","B02A0278E6B98DEC70DFA4FC7EFE1C03");</p> <ul class="ul" id="Interface_Documentation__ul_c4r_gg5_xmb"> <li class="li"><strong class="ph b">To query the report of short message sending status, enter the parameter extend.</strong></li> </ul> <p class="p">SmsQueryResult querySmsResult = msgomcpClient.querySmsResult("extended field");</p> <p class="p">System.out.println(JSONObject.fromObject(querySmsResult));</p> </td> </tr> </tbody></table> <ul class="ul" id="Interface_Documentation__ul_d4r_gg5_xmb"> <li class="li"><strong class="ph b">Response Example </strong>(Return Json Format)</li> </ul> <p class="p">{"appid":"52FC69100A311528E0537CE21F0A7CE9","code":"000000","expiretime":"20170420154054","extend":"extended field","msg":"successful","results":[{"messageID":"1005764163","reportResultDescription":"normal","reportResultID":"0","reportTime":"20170420151155","requestID":"201704201511530","totalNumber":"1"}],"token":"FF15310D72A2B89AF16CB666B1838089"}</p> <ul class="ul" id="Interface_Documentation__ul_e4r_gg5_xmb"> <li class="li"><strong class="ph b">Exception Example</strong> (Return Json Format)</li> </ul> <p class="p">{"appid":"52FC69100A311528E0537CE21F0A7CE9","code":"000000","expiretime":"20170420154054","extend":"extended field","msg":"successful","results":[{"messageID":"1005764163","reportResultDescription":"users reason: the mobile phone is in abnormal status (power off, unable to be connected, or out of service)","reportResultID":"4","reportTime":"20170420151155","requestID":"201704201511530","totalNumber":"1"}],"token":"FF15310D72A2B89AF16CB666B1838089"}</p> <p class="p"><strong class="ph b">5. Query the result of MO reply short messages</strong></p> <ul class="ul" id="Interface_Documentation__ul_f4r_gg5_xmb"> <li class="li"><strong class="ph b">Scenario Description</strong></li> </ul> <p class="p">Query the sending result of the MO short messages replied by users and return the short message sending results that are not queried. A maximum of 1000 items of records will be returned each time.</p> <ul class="ul" id="Interface_Documentation__ul_g4r_gg5_xmb"> <li class="li"><strong class="ph b">Interface Message Name</strong></li> </ul> <p class="p">Interface URL: https://api.xiaoxi.pingan.com.cn/rest/msg</p> <p class="p">Method: fetchNewSms</p> <p class="p">Initiator: Related system</p> <p class="p">Receiver: Message Cloud platform</p> <p class="p">Type of message sending: <strong class="ph b">POST</strong></p> <p class="p"><strong class="ph b">5.1 Request Parameters</strong></p> <p class="p">Null</p> <p class="p"><strong class="ph b">5.2 Response Parameters</strong></p> <table class="table" id="Interface_Documentation__table_h4r_gg5_xmb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_h4r_gg5_xmb__entry__1">Name</th> <th class="entry" id="Interface_Documentation__table_h4r_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_h4r_gg5_xmb__entry__3">Example</th> <th class="entry" id="Interface_Documentation__table_h4r_gg5_xmb__entry__4">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_h4r_gg5_xmb__entry__1 "> <p class="p">Public response parameter</p> </td> <td class="entry" headers="Interface_Documentation__table_h4r_gg5_xmb__entry__2 "></td> <td class="entry" headers="Interface_Documentation__table_h4r_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_h4r_gg5_xmb__entry__4 "> <p class="p">For more information about detailed definitions, see Public Response Parameters.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_h4r_gg5_xmb__entry__1 "> <p class="p">results</p> </td> <td class="entry" headers="Interface_Documentation__table_h4r_gg5_xmb__entry__2 "> <p class="p">List</p> </td> <td class="entry" headers="Interface_Documentation__table_h4r_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_h4r_gg5_xmb__entry__4 "> <p class="p">Each object in the results is a Jason object. The following table describes its attributes.</p> </td> </tr> </tbody></table> <p class="p">Results attribute</p> <table class="table" id="Interface_Documentation__table_i4r_gg5_xmb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_i4r_gg5_xmb__entry__1">Attribute</th> <th class="entry" id="Interface_Documentation__table_i4r_gg5_xmb__entry__2">Type</th> <th class="entry" id="Interface_Documentation__table_i4r_gg5_xmb__entry__3">Example</th> <th class="entry" id="Interface_Documentation__table_i4r_gg5_xmb__entry__4">Description</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__1 "> <p class="p">serviceID</p> </td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__4 "> <p class="p">Service ID. Service ID can be used to distinguish different interactive businesses (a service ID contains a maximum of three digits).</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__1 "> <p class="p">mobileNo</p> </td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__4 "> <p class="p">Users’ mobile phone number.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__1 "> <p class="p">content</p> </td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__4 "> <p class="p">Short message content sent by users.</p> </td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__1 "> <p class="p">receiveDate</p> </td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__2 "> <p class="p">String</p> </td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__3 "></td> <td class="entry" headers="Interface_Documentation__table_i4r_gg5_xmb__entry__4 "> <p class="p">The date when the platform receives short messages replied by users.</p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">5.3 Request Example</strong></p> <p class="p"><a class="xref" href="http://apitest.xiaoxi.pingan.com.cn/rest/msg?method=fetchNewSms&appid=52FC69100A311528E0537CE21F0A7CE9&timestamp=20170821110720&sign=21CF5D93269209B1E011F917CBD94508" target="_blank">http://apitest.xiaoxi.pingan.com.cn/rest/msg?method=fetchNewSms&appid=52FC69100A311528E0537CE21F0A7CE9&timestamp=20170821110720&sign=21CF5D93269209B1E011F917CBD94508</a></p> <p class="p"><strong class="ph b">Realize with SDK of Java version</strong></p> <table class="table" id="Interface_Documentation__table_j4r_gg5_xmb"><caption></caption><colgroup><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <ul class="ul" id="Interface_Documentation__ul_k4r_gg5_xmb"> <li class="li"><strong class="ph b">Create and send a short message to a client. Enter URL, application ID, and secret.</strong></li> </ul> <p class="p">MSGOMCPClient msgomcpClient = new MSGOMCPClient("https://apitest.xiaoxi.pingan.com.cn/rest",</p> <p class="p">"52FC69100A311528E0537CE21F0A7CE9","E0AA7BF266B9BADFF436D62A2D227A88");</p> <ul class="ul" id="Interface_Documentation__ul_l4r_gg5_xmb"> <li class="li"><strong class="ph b">To query the status report of sending MO reply short messages, enter the parameter extend.</strong></li> </ul> <p class="p">SmsQueryResult fetchNewSms = msgomcpClient.fetchNewSms ("extended field");</p> <p class="p">System.out.println(JSONObject.fromObject(fetchNewSms));</p> </td> </tr> </tbody></table> <ul class="ul" id="Interface_Documentation__ul_m4r_gg5_xmb"> <li class="li"><strong class="ph b">Response Example </strong>(Return Json Format)</li> </ul> <p class="p">{</p> <p class="p"> "code": "000000",</p> <p class="p"> "msg": "successful",</p> <p class="p"> "appid": "52FC69100A311528E0537CE21F0A7CE9",</p> <p class="p"> "extend": "",</p> <p class="p"> "expiretime": "20170821112636",</p> <p class="p"> "token": "8C48538D348550D6B164E5B8ECC4A372",</p> <p class="p"> "results": [</p> <p class="p"> {</p> <p class="p"> "serviceID": "12",</p> <p class="p"> "mobileNo": "13900139003",</p> <p class="p"> "content": "TD",</p> <p class="p"> "receiveDate": "20170818103452"</p> <p class="p"> }</p> <p class="p"> ]</p> <p class="p">}</p> <ul class="ul" id="Interface_Documentation__ul_n4r_gg5_xmb"> <li class="li"><strong class="ph b">Exception Example</strong> (Return Json Format)</li> </ul> <p class="p">{</p> <p class="p"> "appid": "52FC69100A311528E0537CE21F0A7CE9",</p> <p class="p"> "code": "111004",</p> <p class="p"> "expiretime": "",</p> <p class="p"> "extend": "",</p> <p class="p"> "msg": "signature failure",</p> <p class="p"> "token": ""</p> <p class="p">}</p> <p class="p"><strong class="ph b">Appendixes</strong></p> <p class="p"><strong class="ph b">Interface Return Code</strong></p> <table class="table" id="Interface_Documentation__table_o4r_gg5_xmb"><caption></caption><colgroup><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="Interface_Documentation__table_o4r_gg5_xmb__entry__1">Return code</th> <th class="entry" id="Interface_Documentation__table_o4r_gg5_xmb__entry__2">Description</th> <th class="entry" id="Interface_Documentation__table_o4r_gg5_xmb__entry__3">Remarks</th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">000000</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Successful.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">110001</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The query does not have return data.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">110002</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The required parameter cannot be empty, or case sensitivity of the incoming parameter name does not match.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">110003</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Network error.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">110004</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">System internal error.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">110006</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">HTTP request method is not supported.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">111001</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The current API method is empty or not found.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">111002</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Application of the appid is not found or is disabled.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">111003</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The timestamp field cannot be empty and its format must be yyyyMMddHHmmss.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">111004</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The signature failed.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">111005</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The sign field cannot be empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">111006</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The difference between the time in the timestamp field and current sever time cannot be over 10 minutes.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">111007</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The time format must be yyyyMMddHHmmss.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">111008</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">It is not a valid JSON format.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113001</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The format of mobile phone number is incorrect.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113002</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The number of parameter sets and mobile phones must be identical.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113003</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The maximum quantity of mobile phone numbers in each request is 200.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113005</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The business system ID is empty, so the request is denied.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113006</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The business system ID is not found or disabled, so the request is denied.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113007</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The request ID defined by the client business system is empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113008</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The request ID defined by the client business system is not of long type.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113009</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The length of the request ID defined by the client business system exceeds the maximum length of 19.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113010</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The required template is not found.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113011</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The short message expires.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113012</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The mobile phone number to be sent short messages is not found.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113013</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The parameter value is not found.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113014</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The number of parameter values is not matched with that of the key.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113015</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The number of parameter value lists is not matched with that of the mobile phone numbers.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113016</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The mobile phone number of the client business system is empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113017</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The length of the mobile phone number that receives short messages is incorrect.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113018</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The mobile phone number that receives short messages contains illegal characters.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113019</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The content of a short message is sent repeatedly.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113020</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The number of request IDs defined by the client business system is not matched with that of the mobile phone numbers.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113021</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The template is not found nor enabled.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113022</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">paramKeys and paramValues must have values at the same time.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113023</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Ordinary short messages and international short messages fail to be sent.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113024</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The international mobile phone number must begin with 00.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113025</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">No sending type is found. Please confirm whether it is an ordinary short message, OTP short message, or international short message.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113026</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The template ID of an OTP short message must begin with otp.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113040</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The allowance of {0} short messages for trial is used up. Contact your customer manager.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 ">{0} refers to the number of short messages.</td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113041</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Mobile phone: {0} is not in the whitelist. Contact your customer manager.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 ">{0} refers to the mobile phone number.</td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113042</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The allowance of short messages for trial is not enough for sending. Please decrease the quantity of mobile phone numbers to be sent short messages.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113043</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The short messages are sent much frequently in a short time.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">113044</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The service ID must be in the format of digit and its length cannot be over three digits.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1001</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Invalid <%field name%>.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1002</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The length of short message content exceeds the limit.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1003</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The incoming tag is incomplete.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1004</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The sender field is empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1005</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The sender serial number field is empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1006</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The required template is not found.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1007</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The template content field is empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1008</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The entered template variables are incomplete.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1009</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The entered template variables values are too long.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1010</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Incorrect virtual user <%virtual username%>.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1011</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The virtual user <%virtual username%> has no permission to call the template <%template ID%>:<%template name%>.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1012</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The template is not available <%reasons for being unavailable%>.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1013</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The content of the short message cannot be sent.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1014</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The short message expires.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1015</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The user rejects the short message.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1016</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The short message deliveries exceed the maximum frequency of resending short messages.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1017</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The field of mobile phone number that receives short messages is empty or its length is not enough.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1018</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The mobile phone number that receives short messages contains illegal characters.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1019</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The length of a mobile phone number of China Mobile is 11 digits.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1020</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Other errors.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1021</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The length of a mobile phone number of China Unicom is 11 digits.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1022</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The entered mobile phone number is not corresponded to an ISP.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1023</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The message is dealt.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1024</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The arranged sending time expires.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1030</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The second-time confirmation failed.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1031</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Link ID does not have an MT template.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1033</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The virtual user field is empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1034</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The number of short messages exceeds the maximum deliveries.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">1035</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The short message content field is empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118001</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The signature factor is empty or incorrect.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118002</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The phone number is empty or incorrect.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118003</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The phone number is empty or incorrect.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118004</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The verification code is empty or incorrect.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118005</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The verification code format is incorrect.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118006</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The verification code fails to be sent.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118007</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The verification code fails to be verified or it expires.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118008</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The valid length of a signature factor is one to eight characters.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118009</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The signature factor format is incorrect or separated with commas (a signature factor must contain digits or letters with a valid length of 1 to 100).</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118010</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The valid length of a policy is 1 to 50 characters.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">118011</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The policy format is incorrect or separated with commas (a policy must contain non-Chinese characters with a valid length of 1 to 50 characters).</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210000</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Query the summary of error MT short messages of SMS enterprises (three days ago). </p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210001</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Query the summary of error MT short messages of SMS enterprises (in the past three days).</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210002</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Query the summary of enterprises receiving MT short messages (abnormality occurs).</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210003</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The date cannot be empty.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210004</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The date format is incorrect.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210005</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The start time cannot be later than the end time.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210006</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Only data in three days ago can be queried.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210007</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">Only data in the past three days can be queried.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210008</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The type value can only be true or false.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> <tr class="row"> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__1 "> <p class="p">210009</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__2 "> <p class="p">The application does not have the query permission.</p> </td> <td class="entry" headers="Interface_Documentation__table_o4r_gg5_xmb__entry__3 "></td> </tr> </tbody></table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products