Create IVR Call

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/createIvrCall

Use the Create IVR Call endpoint to create an IVR call entry. This endpoint connects your IVR system to Galileo's IVR system for PIN setting.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
465-01	Unknown IVR call type
465-02	Invalid parameters passed in 'callParams' parameter
465-03	Customer has no registered phone numbers
465-04	Error queuing calls
465-05	Internal configuration error

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

The PRN or PAN of the account.
Pattern: PAN or PRN
Example: "074103447228"

callType

string

required

The type of call. CPIN is the only valid value.
Pattern: Alphabetic string
Example: "CPIN"

callParams

string

required

JSON-encoded array of call parameters.
Pattern: JSON string
Example: "{"panLastFour":"1234", "passCode":"0123", "expiryDate":"2011-01-01"}"

phone

string | null

Phone number where to route outbound calls. This number supersedes any account-related phone numbers.
Pattern: Exactly 10 digits, no hyphens or other characters
Example: "8013656060"

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default