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.

200

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
    }
  ]
}

401

Invalid token used.

4012

{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}

4010

{
    "error": {
        "code": 4010,
        "msg": "Not Authenticated"
    }
}

403

Token of wrong type used.

{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}

422

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

JSON

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

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"]}]'

Sending FLASHCALL conversion

POST https://direct.i-dgtl.ru/api/v1/flashcall-conversion

The method is used to report the correctness of the user-entered code sent in a FLASHCALL message

Headers

Name	Type	Description
Authorization*	string	Bearer {TOKEN_1}
Content-Type*	string	application/json

Request Body

Name	Type	Description
messageUuid*	string	FLASHCALL message uuid
result*	string	Code entry result Code approved: NUMBER_VERIFIERD Invalid code: WRONG_CODE
code	string	Code

200 This corresponds to the response to sending single messages

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

Enumerations:

Parameter	Allowed values
result	FLASHCALL conversion result

Sending the conversion assists in improvement of the quality of sending FLASHCALL-messages

Request example

JSON

POST https://direct.i-dgtl.ru/api/v1/flashcall-conversion
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
[
  {
    "messageUuid": "063464ec-a34f-4558-90c5-984395000004",
    "result": "NUMBER_VERIFIED",
    "code": "7777"
  }
]

cURL

curl -X POST 'https://direct.i-dgtl.ru/api/v1/flashcall-conversion' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-d '[{"messageUuid":"063464ec-a34f-4558-90c5-984395000004","result":"NUMBER_VERIFIED","code":"7777"}]'