Skip to content

Getting Message Statuses

Request

Get message statuses

NumberTitle
1Delivered
2Not delivered
4Sent to phone
8Transferred to the operator
16Rejected by operator
52Not enough funds

In the event of an error, the corresponding HTTP status code is returned. In some cases, a descriptive error message is also included in the response. The following error codes may be returned by all API methods:

error codeHttp status codeTitleDescription
5400ENTITY_VALIDATION_ERRORThe request body did not pass validation
10400FIELD_VALIDATION_ERRORParameter not validated
15403ACCESS_FORBIDDENThe action is not available, the application does not have the required permissions.
20401INVALID_PARTNER_TOKENpartner_token missing or invalid
30404RESOURCE_NOT_FOUNDThe resource at the requested path does not exist

When sending SMS, the delivery_callback_url attribute is passed in the request - this is the url to which message statuses should be sent.

Use it to send message statuses. Url to which message statuses should be sent - https://app.alteg.io/smsprovider/status/callback/{partner_token}

Security
BearerPartnerUser
Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token

Bodyapplication/jsonrequired
Array [
idstring

Identifier

statusnumber

Message status

payment_sumnumber

Full message cost

currency_isostring

Currency ISO

parts_amountnumber

Amount of message's parts

]
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/delivery/status \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "232674",
      "status": 1,
      "payment_sum": 0.045,
      "currency_iso": "EUR",
      "parts_amount": 2
    }
  ]'

Responses

OK

Bodyapplication/json
Response
{ "success": true }