SMS Flows

This part of the document contains the list of services that can be integrated in flows above. 2 configuration parameters will be shared during integration:

username
Username for basic authentication

password

Password for basic authentication

send-sms (POST)

This service is used to send a SMS. Use '/n' escape char to add new line.

URL

^^/send-sms

Request Headers

Header
Description

x-akinon-request-id

Unique ID for problem solving & tracing.

x-akinon-api-version

Akinon Customer API version.

Authorization

“Basic {BASE64_encoded(username:password)}”

Request Body raw (json)

{
  "from": "", //e.g. AKINON
  "to": "", //in E-164 format, e.g. +905323001020
  "text": "",
  "isOtp": false //OPTIONAL, default: false
}

Response 201 (with no body)

Response Body For Errors (ALL)

If any errors are encountered in the services, these errors should be reported in the format below, and the list of error codes should be shared with Akinon.

Response Body raw 4xx/5xx (json)

{
    "errors": [
       {
           "code": "",
           "field": "",
           "message": ""
       }
   ]
}

Last updated

Was this helpful?