Latest Legacy

The Session object

The API creates a Session object once for each recipient within the code expiry time. You can configure your expiry time while creating applications.

A Session object has these attributes.

Attributes

session_uuid string

A 36-character string that uniquely identifies a session detail record.

app_uuid string

ID of the application used to trigger the session.

recipient string

The destination phone number (in E.164 format) to which the message was sent.

status string

The current status of the session.

Allowed values: in-progress, verified and expired.

channel string

The last channel used for the session.

locale string

This is the language translation in which your session was attempted.

This feature is available upon request only. Raise a support ticket and provide the translations you want to use.

otp_attempts object

An object containing details of all the attempts made during a session and the same channel, ID, time, and status.

chargesobject

An object containing details of all the charges incurred during a session and the same channel, ID, and charge.

created_atstring

UTC time when the session was created.

updated_atstring

UTC time when the session was last updated.