开发者
让沟通无国界，让交流畅通，让心灵互通
SMS Outbound Sending
Remarks
Return parameter description
Return an example
Parameter
Request method
Brief description
Remarks

-HTTP error code

code description
0 Request successful
1 The application is unavailable or the key is incorrect
2 The parameter is incorrect or empty
3 Insufficient balance
4 The content is empty or contains illegal keywords
5 The content is too long
6 The number is incorrect.
8 The sourceaddress/sender must be 1 to 20 digits or English letters
9 IP illegal
27 The frequency limit has been activated, reaching the upper limit for the same number to be sent within one hour (5 messages per hour).
28 TPS rate limiting has been enabled, and the current flow rate has reached the upper limit of the configured TPS flow rate
88 Request failed
99 System Error
102 The current account or the account of the affiliated agent has been deactivated
104 The application of the verification code channel does not allow the submission of more than five numbers at one time


-SMPP submitted SMS error code

code description
10 [0x0000000A] sourceaddress (sender) error
81 [0x00000051] Invalid Number Format
88 [0x00000058] Frequency limit
103 [0x00000067] Insufficient balance
260 [0x00000104] Empty Content or Restricted Keywords
69 Submission failed, unknown error (Complain to us, we'll check the log)


Return parameter description
parameter name type description
result string Request Result description
messageid string The SMS ID returned by the system
code string Result encoding


Return an example
{"result":"Request successful","messageid":"20d6c660bd664c65bef20026564b0b79","code":"0"}
Parameter
Parameter name Required Type Explanation
appkeyYes stringSMS application appkey
secretkeyYes stringSMS application secretkey
phoneYes stringCallee number (country code + mobile number, e.g.: 8615088888888). Multiple numbers allowed when separated by ",". For verification code SMS applications, batch submission is limited to ≤5 numbers
contentYes stringSMS content (must be URL-encoded in UTF-8), max 1000 characters
source_addressNo stringSource address (1-20 alphanumeric characters)
sys_messageidNo stringUser-defined messageid, with a length of 10 to 50 characters, type [0-9a-zA-Z-] (This field does not take effect if there is more than one mobile phone number)
short_linkNo string Short link, the data comes from the short link list; if a value is assigned here, the SMS content must contain #1# to take effect, please note.
linkVerboseNo string This parameter determines whether to collect user click behavior. If click behavior collection is enabled, you can view the phone number information of users who clicked the short link in the console. Values: 1 = collect; 0 = do not collect. Default: collect.
dr_urlNo string dr Push address (If a dr Push address is also configured on the SMS application, give priority to pushing dr To the address configured on this interface); If there is more than one mobile phone number, this field will not take effect. Please contact noc and set it to the specific SMS application.
extNo string Transparent transmission field, this field is custom information and will be returned as is in the receipt. It only supports http requests (if there is more than one mobile phone number, this field will not take effect).
opt_entity_idNo string Please send the entity ID (EntityId) registered under the Indian (91) DLT rule
opt_template_idNo string Please send the template ID (TemplateId) after registration under the Indian (91) DLT rule
opt_header_idNo string Please send the sender ID (HeaderId) after registration under the Indian (91) DLT rule


Request method

  • URL：http://api.ueasytel.com/api/sms/mtsend

  • Method：POST

  • Content-Type: application/x-www-form-urlencoded

  • curl Example （After using the -d parameter, HTTP requests will automatically add the header Content-Type: application/ x-ww-form-urlencoded. And it will automatically convert the request to the POST method, so -X POST can be omitted.）

curl -d "appkey=1&secretkey=2&phone=123&content=abc" http://api.ueasytel.com/api/sms/mtsend

  • For request examples, refer to the HTTP form submission method and the C# request SMS interface code examplepostman example


Brief description

  • Downlink SMS interface