Sending FLASHCALL

Sending FLASHCALL messages

POST https://direct.revicom.ltd/api/v1/message

The method allows for sending an array of single messages (1 to 1,000)

Headers

Name

Type

Description

Authorization*

string

Basic {TOKEN_1}

Content-Type*

string

application/json

Request Body

Name

Type

Description

channelType*

string

Sending channel (FLASHCALL)

senderName*

string

Sender name. Any string is allowed. The call will come from a number, the last digits being the sent code.

destination*

string

Subscriber number

content*

string

Numerical code, 4 symbols

tags

array

Message tags (array of strings). Each tag must match the expression ^\w+$ (any case letters, numbers and underscore "_" are allowed)

callbackUrl

string

Address to send callback

callbackEvents

array

Events to send callback (an array of strings). If there is callbackUrl and no callbackEvents in the request, a callback will be sent on the event delivered.

If the request is successful, a response is returned that lists the message IDs and result codes. With errors = false, all submitted messages are guaranteed to have been successfully generated.

{
  "errors": false,
  "items": [
    {
      "messageUuid": "063474ec-a34f-4558-90c5-984395000004",
      "code": 201
    },
    {
      "messageUuid": "063564ec-a34f-4558-90c5-984395000005",
      "code": 201
    }
  ]
}

The request body contains invalid parameters; below are some response examples.

{
    "error": {
        "code": 4220,
        "msg": "Invalid content"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Invalid msisdn"
    }
}

If you need to use codes consisting of more than four digits, please contact customer support.

Recommended minimum timeout: 70 seconds

Enumerations:

Parameter

Allowed values

callbackEvents

Callback Events

Request example

POST https://direct.revicom.ltd/api/v1/message
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
[
  {
    "channelType": "FLASHCALL",
    "senderName": "any sender",
    "destination": "14085553911",
    "content": "1234",
    "callbackUrl": "https://company.com/callback",
    "callbackEvents": [
      "sent",
      "delivered"
    ],
    "tags": [
      "tag1",
      "tag2"
    ]
  }
]

curl -X POST 'https://direct.revicom.ltd/api/v1/message' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-d '[{"channelType":"FLASHCALL","senderName":"any sender","destination":"14085553911","content":"1234","callbackUrl":"https://company.com/callback","callbackEvents":["sent","delivered"],"tags":["tag1","tag2"]}]'