HTTP API - Stop SMS Sending Task

From Ultiroam User Docs
Jump to navigation Jump to search

GET https://gateway_ip/api/stop_sms

Request Parameters:

Parameter Type Description
Required Parameter
task_id Integer The ID of the task to be stopped, which corresponds with the task-id carried in the response of SMS sending request

Response Parameter:

Parameter Type Description
error_code Integer Codes that may be returned:

200: SMS sending task has been stopped

404: SMS sending task cannot be found 500: Other errors

sn String SN of the gateway

Example of Stopping SMS Sending Task:

Request: https://gateway_ip/api/stop_sms?task_id=1

Response:{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx"}