One, express 100 SMS sending interface

1.1 Request Address

http://apisms.kuaidi100.com:9502/sms/send.do

https://apisms.kuaidi100.com/sms/send.do

1.2 Request Types

POST

1.3 Request Parameters

Request parameters (header)

The name of the type The default value
Content-Type string application/x-www-form-urlencoded

Request Parameters (Body)

The name of the type If required The sample value Parameters to describe
sign String is 4BBDE07660E5EFF9 0873642CFAE9A8DD Encrypted signature information:MD5(key + userid); After encryption, the string is capitalized to 32 bits
userid String is 9974ef2c377a4dbt9 c8g1b64dd6311ea The company number we assigned to your company, pleaseApply for enterprise EditionTo obtain
seller String is Express 100 Signature of merchant name; It is better to use abbreviation, which is displayed in the label of the SMS message. No more than 5 characters
phone String is 13568688888 Mobile phone number for receiving SMS messages
tid long is 11 SMS Template ID
content String is {” recipient name “:” wang shuai “, “company name” : “100”, “delivery order” : “154893238584”, “url” : HTTPS: / / api.kuaidi100.com/home “} Replace the SMS template
outorder String no 143255893 External order number: If the SMS sending template has a callback address, the external order number is returned to the caller for data update
callback String no http:// xxx/callback Callback address: If the customer sets this parameter when sending SMS messages, the SMS sending status will be callback based on this parameter. If the value is null, the system returns the status of sending SMS messages based on the IP address configured in the template. If neither parameter is specified, the notification status will not be called back

1.4 Example Request Parameters

    sign= "4BBDE07660E5EFF90873642CFAE9A8DD"
    userid= "9974ef2c377a4dbc9c8c1b64dd6311ea"
    seller= "100"
    phone= "13566688888"
    tid= 11
    content = {
        "Name of Recipient": "Wang shuai"."Company name": "100"."Tracking Number": "154893238584"."url": "http://www.kuaidi100.com"
    }
    outorder = "143255893"  
Copy the code

1.5 Result

The parameter name The data type The sample value Parameters to describe
status integer 1 Status value: 0- Indicates failure; 1- Indicates success
data object Return data information
msg String Message content: Returns the description of the specific message body
extra object Additional information
total integer This value represents the total number of entries in the data

1.6 Example Of Returned Data

{
    "status": 1."data": ""."msg": "Text in transit..."."extra": ""."total": 0
}    
Copy the code

Two, express 100 SMS callback request

2.1 Callback Information

The parameter name The data type The sample value Parameters to describe
status integer 1 Status value: 0- Indicates failure; 1- Indicates success
Θ data object Data: SMS sending status is displayed
└ outorder String 143255893 The incoming external order number
└ message String OK Additional information
└ status String Send a success SMS sending status: Sending succeeded, sending failed, receiving succeeded, receiving failed
└ sign String MD5(ID + phone + outorder); The verification mode is MD5 encryption: template ID+ mobile phone number + external order number. The user can determine whether to process the request based on the encrypted signature
msg String Message content: Returns the description of the specific message body
extra object Additional information
total integer This value represents the total number of entries in the data

2.2 Example of Returned Data

{
    "status": 1."data": {
        "outorder": "143255893"."message": ""."status": "Sent successfully"
    },
    "msg": "SMS sending result message"."extra": ""."total": 0
}       
Copy the code

2.3 Example of Request Packet Response

{
    "status": true
}
Copy the code

I. Product introduction

The SMS interface provides the SMS sending function for the enterprise customers of Express 100. The caller first creates the SMS template through our enterprise management background, and Express 100 will review the SMS template according to relevant national laws and regulations. Enterprises can send SMS messages to partners and customers after approval.

2. Application scenarios of SMS API

  1. After the enterprise sends the goods or the e-commerce enterprise sends the goods, it notifies the recipient of the goods by SMS.
  2. According to the status of logistics track, the recipient can be informed of the status of goods in transit, remind the recipient to sign for timely receipt;
  3. Can send marketing messages to customers, event promotion messages, promote products and improve brand image.

Third, SMS API charging mode

1. Charging method

The SMS service uses the prepaid payment method. After registering the express 100 account, merchants can view the package and purchase the number of SMS messages in the enterprise management background.

2. Fees

The SMS service charges 0.04 yuan per message.

Each time the enterprise successfully invokes the interface, the number of SMS messages will be deducted. If the number of SMS messages has been deducted, the enterprise needs to recharge and purchase again.

3. Invoice

Express 100 supports issuing VAT invoices. After purchase, users can request invoice from the enterprise management background – expense center – payment record -. General electronic VAT invoice is issued by default, and special VAT invoice can be issued for more than 1000 yuan.

Official documents:

Api.kuaidi100.com/document/5f…

Api.kuaidi100.com/document/5f…