Server-side REST API overview

Server REST API Overview

JSMS provide compliance REST normative HTTP API, for developers to call remotely JSMS Services provided.

At the same time, for the convenience of developers, JSMS API, also providesDevelopment kits for a variety of commonly used programming languages (SDK）。

REST API basic constraints

API is designed to comply with HTTP, REST specification. For example: query request uses Get method to submit a request using Post method. If a request is not appropriate HTTP method will return an error.
If there is no special instructions, the calling parameter value should be transcoded as:UTF-8, URL encoding[^1].

[1]: URL Encoding - WikiPedia definition

API Resource list

Send SMS API

name	resource	Remark
Send text verification code SMS API	POST https://api.sms.jpush.cn/v1/codes	JiguangPlatform generates verification code
Verification code API	POST https://api.sms.jpush.cn/v1/codes/{msg_id}/valid	JiguangVerify verification code
Send voice verification code text message API	POST https://api.sms.jpush.cn/v1/voice_codes	/
Send a single template message API	POST https://api.sms.jpush.cn/v1/messages	Customize verification code interface and create notification class template
Send batch template SMS messages API	POST https://api.sms.jpush.cn/v1/messages/batch	/

Send SMS regularly API

name	resource
Single scheduled SMS submission API	POST https://api.sms.jpush.cn/v1/schedule
Batch scheduled SMS submission API	POST https://api.sms.jpush.cn/v1/schedule/batch
Modify a single scheduled text message API	PUT https://api.sms.jpush.cn/v1/schedule/{schedule_id}
Batch scheduled SMS modification API	PUT https://api.sms.jpush.cn/v1/schedule/batch/{schedule_id}
Scheduled SMS inquiryAPI	GET https://api.sms.jpush.cn/v1/schedule/{schedule_id}
Scheduled text message deletion API	DELETE https://api.sms.jpush.cn/v1/schedule/{schedule_id}

SMS balance inquiry API

name	resource
Account balance inquiry API	GET https://api.sms.jpush.cn/v1/accounts/dev
Application balance query API	GET https://api.sms.jpush.cn/v1/accounts/app

SMS receipt API

name	resource
Get SMS sending status API	GET https://api.sms.jpush.cn/v1/report
Get uplink SMS messages API	GET https://api.sms.jpush.cn/v1/reply

return code

If the request fails,API Will return as follows JSON Format return code and description

{ "error": { "code": *****, "message": "*****" } }

          {
    "error": {
        "code": *****,
        "message": "*****"
    }
}

This code block is shown in the floating window

REST API Return code summary

HTTP CODE	CODE	MESSAGE	DESC
200	50000	success	Request successful
400	50001	missing auth	auth is empty
401	50002	auth failed	auth Authentication failed
400	50003	missing body	body is empty
400	50004	missing mobile	Mobile number is empty
400	50005	missing temp_id	Template ID is empty
403	50006	invalid mobile	Mobile number is invalid
403	50007	invalid body	body invalid
403	50008	no sms code auth	SMS service not activated
403	50009	out of freq	Send overclocking For the same application and the same called mobile phone number, the sending frequency limit is as follows: 1. There needs to be an interval every time the voice message is obtained. 20s 2. Text verification code SMS 24h／200 strip 3. Notification SMS with the same content 10min／3 messages, no limit on different content, maximum sending limit of all notification messages in one day 200 strip 4. Marketing SMS 10min/3 items
403	50010	invalid code	Verification code is invalid
403	50011	expired code	Verification code expired
403	50012	verified code	Verification code verified
403	50013	invalid temp_id	Invalid template ID
403	50014	no money	Insufficient remaining space for sending text messages
400	50015	missing code	Verification code is empty
404	50016	api not found	API does not exist
415	50017	media not supported	Media type is not supported
405	50018	request method not support	The request method is not supported
500	50019	server error	Server side exception
403	50020	template auditing	Template under review
403	50021	template not pass	Template review failed
403	50022	parameters not all replaced	Not all parameters in the template are replaced
403	50023	parameters is empty	Parameter is empty
403	50024	unsubscribed mobile	Mobile number has been unsubscribed
403	50025	wrong template type	Should API This template type is not supported
403	50026	wrong msg_id	msg_id invalid
403	50027	invalid send_time	The sending time is empty or before the current time
403	50028	invalid schedule_id	schedule_id invalid
403	50029	wrong schedule status	The scheduled text message has been sent or deleted and cannot be modified.
403	50030	recipients is empty	recipients is empty
403	50031	too much recipients	recipients The number of SMS recipients exceeds 1000
403	50034	repeat send	Send repeatedly
403	50035	illegal IP	The request IP is illegal
403	50036	app in black	App is blacklisted
403	50037	has black word	There are sensitive words in the text message content
403	50038	invalid content length	The length of the text message content is wrong. The length of the text message should not exceed 500 characters, the length of the voice message verification code is 4 to 8 digits
403	50039	invalid code type	The content of the voice verification code is incorrect. The verification code only supports numbers.
403	50040	invalid voice language type	The voice verification code broadcast language type is wrong
403	50041	invalid ttl value	Verification code validity period is wrong
403	50042	template is empty	Template content is empty
403	50043	template too long	The template content is too long, and the length limit including the signature is 500 character
403	50044	template parameter invalid	Invalid template parameter
403	50045	remark too long	The remark content is too long, the length limit is 500 character
403	50046	signature not set	The application has not set a signature, please set a signature first
403	50047	modify template not allow	This template does not support modification. Only templates with a status of failed review can be modified.
403	50051	signatures not exist	Signature does not exist/Signature not created
403	50052	template contains special symbol	The template cannot contain special symbols, such as []
403	50053	special template parameter need extra remark for confirmation	There are link variables in the template, please remark Fill in the link in the parameters for reporting to avoid delays in sending text messages due to manual review.
403	50054	content contains special symbol	The text of the text message cannot contain special symbols, such as []
403	50101	invalid image	Picture is illegal
403	50102	invalid sign id	Signature ID is invalid
403	50103	other signatures in the audit	There are already other signatures to be reviewed and cannot be submitted.
403	50104	invalid signature	The signature content is illegal
403	50105	default signature cannot be deleted	The default signature cannot be deleted
403	50201	pull out of frequency	overclocking,API Call frequency: single appKey 5 seconds/time
403	50202	pull not allow	Pulling is prohibited. Suggestion: Please check whether you are currently using callbacks to obtain data.
403	50301	invalid account	SMS developer account is frozen, please contact technical support