Create External Call Outbound Call

Create External Call Outbound Call

Path Parameters

departmentUUID string required
customerUUID string required

application/json

Request Body required

callee object
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
caller object
uuid string
name string
type string
Possible values: [USER, CUSTOMER]
departmentUuid string
party1Number string
party2Number string
numberType string

Possible values: [DRIVER_AND_CUSTOMER DRIV_CALL, TM_AND_CUSTOMER PDM_CALL, SA_AND_CUSTOMER SA_CALL, DRIVER_AND_SA DRIV_SA, DRIVER_AND_TM DRIV_TM]

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

sid string
status string

Possible values: [SUCCESS, FAILURE]

errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "sid": "string",
  "status": "SUCCESS",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

POST /departments/:departmentUUID/customers/:customerUUID/external/call

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/communications

Username

Password

departmentUUID — path required

customerUUID — path required

Body required

{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}

curl / cURL

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

python / requests

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

go / native

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

nodejs / axios

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

ruby / Net::HTTP

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

csharp / RestSharp

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

php / cURL

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

java / OkHttp

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

powershell / RestMethod

curl -L -X POST '/communications/departments/:departmentUUID/customers/:customerUUID/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "callee": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "caller": {
    "uuid": "string",
    "name": "string",
    "type": "USER",
    "departmentUuid": "string"
  },
  "party1Number": "string",
  "party2Number": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'