POST
/
call
/
start
curl --request POST \
  --url https://connect.authsignal.com/v1/call/start \
  --header 'Content-Type: application/json' \
  --data '{
  "referenceId": "<string>",
  "phoneNumber": "<string>",
  "userId": "<string>",
  "username": "<string>",
  "channel": "WHATSAPP"
}'
{
  "messageId": "ef6b3212-6121-4a9e-92ef-09d819e36e93",
  "channel": "SMS"
}

Body

application/json
​
referenceId
string

A reference identifier originating from customer experience/IVR system, this could be the call session id.

​
phoneNumber
string

The phone number of the user to be authenticated, this could be the current calls originating phone number.

​
userId
string

The primary identifier for the user stored in Authsignal.

​
username
string

A username for example a user customer number or email.

​
channel
enum<string>

The channel to be used for the caller authentication link to be sent to the user.

Available options:
WHATSAPP,
SMS

Response

200
application/json
OK
​
messageId
string

The ID of the channel's delivered message, use this as an audit trail to track the message delivery.

​
channel
enum<string>
Available options:
WHATSAPP,
SMS

Was this page helpful?

OverviewOverview