POST api/vodia/agentpickup

Request Information

URI Parameters

None.

Body Parameters

AgentPickup
NameDescriptionTypeAdditional information
from

string

None.

to

string

None.

callid

string

None.

extension

string

None.

id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "from": "sample string 1",
  "to": "sample string 2",
  "callid": "sample string 3",
  "extension": "sample string 4",
  "id": 5
}

application/xml, text/xml

Sample:
<AgentPickup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vodia.Integration.BusinessEntities">
  <callid>sample string 3</callid>
  <extension>sample string 4</extension>
  <from>sample string 1</from>
  <id>5</id>
  <to>sample string 2</to>
</AgentPickup>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Data

Object

None.

HasError

boolean

None.

ErrorCode

integer

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {},
  "HasError": true,
  "ErrorCode": 3,
  "ErrorMessage": "sample string 4"
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vodia.Integration.BusinessEntities">
  <Data />
  <ErrorCode>3</ErrorCode>
  <ErrorMessage>sample string 4</ErrorMessage>
  <HasError>true</HasError>
</ApiResponse>