Page Comparison

The POST v0/{accountKey}/calls/ endpoint allows you to request a call either on behalf of a specific agent or agent group. Designed to support The endpoint supports a number of potential "from" and "to" selectors for future use.

Panel

borderColor	#eeeeee
bgColor	white
titleColor	white
borderWidth	1
titleBGColor	blackgrey
borderStyle	solid
title	In this page

Table of Contents

Insert excerpt

	_ExcerptAPICloud
	_ExcerptAPICloud
nopanel	true

Header

...

parameters

This endpoint requires the following headers:

`Authorization (required)`

This header requires an OAuth bearer token. For information on the bearer token, see How to use your bearer access token.

`Content-Type(required)`

application/

...

json Indicates that the media type sent by the client is JavaScript Object Notation (JSON).

`Accept`

application/json;version=

...

6 Indicates that the client will accept a JSON response and that version 6 of the API should be used.

...

Request examples

The following example below provide provides all possible body parameters:

Code Block

language	js
theme	Midnight

{
  "from": {
    "agentId": "5464",
    "groups": [
      "030"
    ],
    "presentedCLID": "01256636451",
    "consent": "OneParty"
  },
  "to": {
    "telephoneNumber": "07970303957",
    "agentId": "4567"
  },
  "regarding": {
    "reference": "http://Test.com"
  },
  "application": "TestApp"
}

where

from.
- agentId. The Agents display Id as a string, in which the call wil display ID, in string format, of the agent the call will be made from. Mutually exclusive with from.Use either agentID or groups.
- groups. A list of Group display Id as strings, in which the call wil The display IDs of the groups that the call will be made from. Mutually exclusive with from.Use either groups or agentId.
- presentedCLID. The CLID to present to the party being called. This number must be confiugured configured as a callback number on in your VCC account. This The parameter is optional.consent. A string indicating what level of consent the from party requires with regards
to the call being recorded. This parameter is optional. Possible values are:
- Unknown - Consent status is unknown
- OneParty - Only one party must consent for the call to be recorded
- TwoParty - both partiesmust consent for the call to be recorded
to.
- telephoneNumber. The telephony telephone number to call , in E164 format. Mutually exclusive with , that the call will be made to. Use either telephoneNumber or agentId.
- agentId. The Agents display Id as a string, in which you wish to be called. Mutually exclusive with to.telephoneNumber.
- consent. A string indicating what level of consent the from party requires with regards to the call being recorded. This parameter is optional. Possible values are:
  - Unknown - Consent status is unknown
  - OneParty - Only one party must consent for the call to be recorded
  - TwoParty - both partiesmust consent for the call to be recorded
regarding.
- reference. Where ID, in string format, of the agent the call will be made to. Use either agentId or telephoneNumber.
regarding
- reference. Where reference is an alphanumeric string or a valid URL with a maximum length of 2000 characters that contains an external ID of an object this call is regarding.
application. Where appName application is an alphanumeric string—up string — up to 32 characters—specifying characters — specifying which application is calling the API. If integrated with Salesforce, and the feature is enabled, appName application appears in the Tasktask's subject as "Outbound appName call to 02072068888"

...

title	Further details on consent

Consent is used to convey information about which parties on a call must provide consent in order for either one or both legs of the call to be recorded.

Consent must be used as follows:

...

Outbound application call to 02072068888"

Make call from agent 1234 to telephone number 02072068888

Code Block

language	powershell
theme	Midnight

curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/" 
-d '{ "from": { "agentId": "1234" }, "to": { "telephoneNumber": "02072068888" } }' 
-H "Authorization: Bearer <ACCESS_TOKEN>"-H "Content-Type: application/json; version=6"

Body

...

Code Block

language	js
theme	Midnight

{
  "from": {
    "agentId": "1234"
  },
  "to": {
    "telephoneNumber": "02072068888"
  }
}

...

Code Block

language	powershell
theme	Midnight

curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/" 
-d '{ "from": { "agentId": "1234" }, "to": { "agentId": "4567" } }' 
-H "Authorization: Bearer <ACCESS_TOKEN>" -H "Content-Type: application/json; version=6"

Body

...

Code Block

language	js
theme	Midnight

{
  "from": {
    "agentId": "1234"
  },
  "to": {
    "agentId": "4567"
  }
}

...

Code Block

language	powershell
theme	Midnight

curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/" 
-d '{ "from": { "groups": ["030"] }, "to": { "telephoneNumber": "02072068888" } }' 
-H "Authorization: Bearer <ACCESS_TOKEN>"-H "Content-Type: application/json; version=6"

Body

...

Code Block

language	js
theme	Midnight

{
  "from": {
    "groups": [
      "030"
    ]
  },
  "to": {
    "telephoneNumber": "02072068888"
  }
}

...

Code Block

language	powershell
theme	Midnight

curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/" 
-d '{ "from": { "groups": ["030", "200", "400"] }, "to": { "telephoneNumber": "02072068888" } }' 
-H "Authorization: Bearer <ACCESS_TOKEN>" -H "Content-Type: application/json; version=6"

Body

...

Code Block

language	js
theme	Midnight

{
  "from": {
    "groups": [
      "030",
      "200",
      "400"
    ]
  },
  "to": {
    "telephoneNumber": "02072068888"
  }
}

...

Code Block

language	powershell
theme	Midnight

curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/" 
-d '{ "from": { "agentId": "1234", "presentedCLID": "08008888888" }, "to": { "telephoneNumber": "02072068888" } }' 
-H "Authorization: Bearer <ACCESS_TOKEN>" 
-H "Content-Type: application/json; version=6"

Body

...

Code Block

language	js
theme	Midnight

{
  "from": {
    "agentId": "1234",
    "presentedCLID": "08008888888"
  },
  "to": {
    "telephoneNumber": "02072068888"
  }
}

...

Code Block

language	powershell
theme	Midnight

curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/" 
-d '{ "from": { "agentId": "1234", "presentedCLID": "08008888888" }, "to": { "telephoneNumber": "02072068888" }, "regarding": { "reference": "0012400000ATTUQ" }, "application": "appName" }' 
-H "Authorization: Bearer <ACCESS_TOKEN>" 
-H "Content-Type: application/json;version=6"

Body

...

Code Block

language	js
theme	Midnight

{
  "from": {
    "agentId": "1234",
    "presentedCLID": "08008888888"
  },
  "to": {
    "telephoneNumber": "02072068888"
  },
  "regarding": {
    "reference": "0012400000ATTUQ"
  },
  "application": "appName"
}

Make call from agent 1234 to telephone number 02072068888 with consent

Code Block

language	powershell
theme	Midnight

curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/" 
-d '{ "from": { "agentId": "1234", "consent": "OneParty" }, "to": { "telephoneNumber": "02072068888", "consent":
"OneParty" } }' 
-H "Authorization: Bearer <ACCESS_TOKEN>" 
-H "Content-Type: application/json;version=6"

Body

...

Code Block

language	js
theme	Midnight

{
  "from": {
    "agentId": "1234",
    "consent": "OneParty"
  },
  "to": {
    "telephoneNumber": "02072068888",
    "consent":
"OneParty"   }
}

Response

...

examples

Successful calls return HTTP status code of 201, containing the following message and headers.

...

Code Block

language	js
theme	Midnight

{
    "id": "017db4a2-44b5-672e-8b9f-1a805fed07ad",
    "links": [
        {
            "href": "https://emea.newvoicemedia.com/V0/lmccg0ujju4/Calls/017db4a2-44b5-672e-8b9f-1a805fed07ad",
            "rel": "_self"
        }
    ],
    "from": {
        "presentedClid": "123456789",
        "agentId": "1234",
        "consent": "OneParty"
    },
    "to": {
        "telephoneNumber": "02072068888",
        "consent":
"OneParty"     },
    "regarding": {
        "reference": "0012400000ATTUQ"
    },
    "status": "Active",
    "recordingStatus": "Stopped",
    "application": "ExampelAppNameExampleAppName",
    "dispositionCode": null
}

...

Returns HTTP Status Code 400.

Ccxml not enabled - "Ccxml must be enabled for this account"Calling agent busy - ": CCXML is not enabled
Unable to place call - Agent number busy"Destination : Calling agent busy - "
Unable to place call - dialed Agent is not currently available"Unknown destination agent - ": Destination agent busy
Unable to place call - invalid Agent Id.": Unknown calling destination agent - "
Unable to place call - Agent Id is unknown"Invalid number dialed - ": Unknown calling agent
Unable to place call - number is invalid"Call Failed - ": Invalid number dialed
Unable to place call to Agent. Please try again": Call Failed
Telephone number exceeds 30 characters
Agent Id exceeds 11 digits
Agent Id must contain digits only
Telephone number not supported in this context
Agent Id must be specified
Either telephone number or agent id required
Either telephone number or agent id required, not both
Reference exceeded 2000 characters
Reference contained invalid characters
Application exceeded 32 characters
Application contains non-alphanumeric characters

Code Block

language	js
theme	Midnight

{
 "message": "Ccxml must be enabled for this account"
}

...

Returns HTTP Status Code 415.

Unsupported content type - "The requested resource does not support content type 'multipart/form-data'.": Unsupported content type

Code Block

language	js
theme	Midnight

{
 "message": "The requested resource does not support content type 'multipart/form-data'."
}

...

Versions Compared

Old Version 4

New Version Current

Key

Header

parameters

`Authorization (required)`

`Content-Type(required)`

`Accept`

Request examples

Make call from agent 1234 to telephone number 02072068888

Body

Body

Body

Body

Body

Body

Code Block
language js
theme Midnight
{ "from": { "agentId": "1234", "presentedCLID": "08008888888" }, "to": { "telephoneNumber": "02072068888" }, "regarding": { "reference": "0012400000ATTUQ" }, "application": "appName" }

Make call from agent 1234 to telephone number 02072068888 with consent

Body

Code Block
language js
theme Midnight
{ "from": { "agentId": "1234", "consent": "OneParty" }, "to": { "telephoneNumber": "02072068888", "consent": "OneParty" } }

Response

examples

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

Header

parameters

Authorization (required)

Content-Type(required)

Accept

Request examples

Make call from agent 1234 to telephone number 02072068888

Body

Body

Body

Body

Body

Body

Code BlocklanguagejsthemeMidnight{ "from": { "agentId": "1234", "presentedCLID": "08008888888" }, "to": { "telephoneNumber": "02072068888" }, "regarding": { "reference": "0012400000ATTUQ" }, "application": "appName" }

Make call from agent 1234 to telephone number 02072068888 with consent

Body

Code BlocklanguagejsthemeMidnight{ "from": { "agentId": "1234", "consent": "OneParty" }, "to": { "telephoneNumber": "02072068888", "consent": "OneParty" } }

Response

examples

`Authorization (required)`

`Content-Type(required)`

`Accept`

Code Block
language js
theme Midnight
{ "from": { "agentId": "1234", "presentedCLID": "08008888888" }, "to": { "telephoneNumber": "02072068888" }, "regarding": { "reference": "0012400000ATTUQ" }, "application": "appName" }

Code Block
language js
theme Midnight
{ "from": { "agentId": "1234", "consent": "OneParty" }, "to": { "telephoneNumber": "02072068888", "consent": "OneParty" } }