This request allows you to provide steps information

post https://api.eu-west-1.prod.(ussd/sms).protect.evina.com/v1/step

Body Params

step_type

string

required

length ≤ 16

Step type in the current flow. Values, examples

INIT first step
STEP intermediate step
SR for SMS flows only - status report step
OPERATOR_ANSWER
CHECK
ERROR error step during the flow, if occurred (eg. wrong word received)

text

string

length ≤ 16

Message text received or sent

shortcode

string

length ≤ 16

The SMS shortcode (sender ID)

timestamp

date-time

required

Current timestamp, using ISO 8601 format

customer_backend_id

string

length ≤ 32

Gateway identifier(s) (SMS-C / gateway name(s) in case of SMS flow). Will be displayed on your dashboard

transaction_id

string

required

length ≤ 128

This is one unique identifier you have to fill to identify the transaction on our side. One transaction equal one identifier.

step_id

integer

required

Step ID, send 1 for the first step and increment it for each new step in the same flow

imei

string

length ≤ 16

End user's device IMEI (International Mobile Equipment Identity) - 15 digits

location

object

End user's geo-location, object with lat,lon

Responses

200

The step is added

Language

Credentials

Header


xxxxxxxxxx
13
1
<?php
2
require_once('vendor/autoload.php');
3
4
$client = new \GuzzleHttp\Client();
5
6
$response = $client->request('POST', 'https://api.eu-west-1.prod./(ussd/sms).protect.evina.com/v1/step', [
7
  'headers' => [
8
    'accept' => 'application/json',
9
    'content-type' => 'application/json',
10
  ],
11
]);
12
13
echo $response->getBody();

Choose an example:

application/json

400json payload is invalid

401Not Authorized

404transaction id not found

422transaction id is invalid

500Internal Server Error