TrackerRMS Help

Your one-stop shop for help on TrackerRMS

Back to Topics

Help Topic: inboundCall


inboundCall

There are 2 options available for triggering an Inbound Call screen pop, one is a GET call, the other a POST call

GET

/api/telephone/inboundCall?Source=00000000000&Destination=00000000000

Able to send an inbound call to the API to trigger a screen pop.

?Source = the callers telephone number

&Destination = the telephone number being called

 

POST

/api/widget/inboundCall

Sample Request:

{
      "trackerrms": {
             "inboundCall": {
                    "credentials": {
                          "username": "my.name@domain.com",
                          "password": "Welcome123",
                          "oauthtoken": "1bc7ca1e-8b9a-11e9-bc42-526af7764f64"
                    },
                    "instructions": {
                          "source": "441234567890",
                          "destination": "446543210987"
                    }
             }
      }
}

Sample Response:

{
   "status": 0,
   "message": "success",
   "count": 0
}

Response status codes:

0

success (message will be “created” or “updated”)

1

user not found

2

user not active

3

record found and cannot be overwritten

99

Invalid request