findCallerAndCalleeForExternalCall

findCallerAndCalleeForExternalCall

application/json

Request Body required

callRequest

accountSid string
brokerNumber string
callSid string
callerCommunicationValue string
dealerUuid string
departmentUUID 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
• 201
• 401
• 403
• 404

---

OK

*/*

Schema

Example (from schema)

---

Schema

calleeCommunicationValue string
calleeUser object

departmentUuid string

Unique department identifier for user, not mandatory

name string

name of the user

type string

Possible values: [USER, CUSTOMER]

Types of users of mykaarma USER/CUSTOMER

uuid string

Unique identifier for the user of mykaarma

callerUser object

departmentUuid string

Unique department identifier for user, not mandatory

name string

name of the user

type string

Possible values: [USER, CUSTOMER]

Types of users of mykaarma USER/CUSTOMER

uuid string

Unique identifier for the user of mykaarma

errors object[]
Array [
errorCode string
errorDescription string
metadata object
property name* string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "calleeCommunicationValue": "string",
  "calleeUser": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerUser": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /v3/route/external/call

Request

Base URL

//api.mykaarma.com/pickupdelivery

Body required

{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/external/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "accountSid": "string",
  "brokerNumber": "string",
  "callSid": "string",
  "callerCommunicationValue": "string",
  "dealerUuid": "string",
  "departmentUUID": "string",
  "numberType": "DRIVER_AND_CUSTOMER DRIV_CALL"
}'