Skip to content

Request Body

Request

Returns the submitted user body, this is the request as received

Security
HTTP_BASIC
Path
request_idstringrequired

Valid request id

Example:c9220015e2f48bc7cf4b38186a7b2025
curl -i -X GET \
  -u '<username>:<password>' \
  https://tapi.avanser.com/v1/requests/c9220015e2f48bc7cf4b38186a7b2025/request_body

Responses

Successful response

Bodyapplication/json
namestring

desired service friendly name

Example:"Tracking Service 1"
service_numberstring

configured service number (E164 format)

Example:"61290081596"
serviceobject

Service configuration details

call_uristring

if defined sets the url for the Call-URI functionality, each call is reported to this url if configured.

Example:"http://path/to/call_reporting_uri"
sms_forward_uristring

If defined, each inbound SMS is sent to this URL using HTTP POST, with the parameters in the request body.

Example:"http://path/to/sms_forward_uri"
Response
{
  "name": "Tracking Service 1",
  "service_number": "61290081596",
  "service": {
    "type": "transfer",
    "answer_point": "61401010023",
    "answer_point_name": "Sydney Office",
    "record_call": true,
    "transcription": { … },
    "call_greeting": "http://path/to/greeting.wav",
    "call_whisper": "http://path/to/greeting.wav",
    "voicemail": "http://path/to/voicemail.wav",
    "call_reporting": { … }
  },
  "call_uri": "http://path/to/call_reporting_uri",
  "sms_forward_uri": "http://path/to/sms_forward_uri",
  "@links": {
    "service_uri": "/services/61290081596"
  }
}