Exchange Pre-Call API For Branded Communication

The Pre-Call API facilitates the aNumber to bNumber pairing required to create an active INFORM Paired program.

Pre-Call Endpoint

A Pre-Call push with the user's number pair must be submitted ahead of the actual phone call in order to ensure the Paired Program Caller Name displays on the end device. To do this, the following endpoint is available:

A POST Action that submits the required data to be prepped ahead of the call.

The following information is required for this request:

Parameter

Description

aNumber*
string

The E.164-formatted originating, or calling, phone number

bNumber*
string

The E.164-formatted terminating, or called, phone number

businessId
string

Unique Identifier of the Business making the call

programId*
string

Unique identifier of the Program used for the call

services*
string

Name of the services to be used for pairing the call

ttlSeconds
integer

Time-to-live (in seconds) for this call treatment
Minimum: 1 minute (60 seconds)
Maximum: 10 minutes (600 seconds)
*Default (recommended): 2 minutes (120 seconds)

*Required field

If the request is submitted correctly, the following 200 OK Success response will be shown:

{
  "body": {
    "message": "OK"
  },
  "error": "null"
}

Wanna get cookin'? Follow our step-by-step recipe:


Did this page help you?