SetStatus

[POST] .../v1/sms/setstatus

Changes the status of a single SMS message Use this method when an SMS gateway callback or an integration worker reports a delivery state change for a single SMS message. The request body is required and must include id and a non-default status; error_message is optional and is used only for Error status, where values longer than 1000 characters are trimmed before saving. Runtime status transitions are validated: Sended requires the current status New, Delivered requires the current status Sended and invalid transitions are rejected; successful updates fire the SMSStatusSet webhook and return an empty success result. The caller must have SMS send permission 586; missing body, invalid status, missing SMS record, invalid status transition, denied permission and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
error_message String Optional Error message for Error status. Values longer than 1000 characters are trimmed by the current endpoint before saving.
id Int64 Required SMS message ID.
status String Required New SMS message status. Valid runtime transitions are New to Sended, Sended to Delivered or setting Error for a failed message. Allowed values: Default, New, Sended, Delivered, Error.

Request Example

{
  "id": 1001,
  "status": "Sended"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Object Result object.

Response Example

{
  "ok": true,
  "result": null
}