POST communications/queue/reject
This method is used to set the life cycle state of a communication queue to rejected
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
| communication_queue_identifier (mandatory) | Communication queue Identifier | The identifier of the communication queue. The allowed communication queue identifier fields are the following:
| |||||||||
error_code (mandatory) | String | The code of a possible error that occur while processing the communication queue entry | |||||||||
error_description (mandatory) | String | The description of a possible error that might occur while processing the communication queue entry | |||||||||
fields_set (optional) | List of Strings, comma separated
| A list of fields that should be included in the results. If not specified then all the available fields will be returned Available from CRM.COM R10.0.0 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved communication queue entry |
number | String | The number of the retrieved communication queue entry |
life_cycle_state | String | The lifecycle state of the retrieved communication queue entry which can be PENDING, REJECTED, COMPLETED or COMPLETED_AND_REMOVED. Life Cycle State COMPLETED_AND_REMOVED is available from CRM.COM R10.1.0 |
| error_code | String | The code of a possible error that occur while processing the communication queue entry |
| error_description | String | The description of a possible error that might occur while processing the communication queue entry |
| communication | Communication object | The communication that is sent through the retrieved communication queue entry |
| communication_queue_external_system | Communication Queue External System object | The external system which process the communication waiting in retrieved communication queue entry |
Log Information Object | The log information related with the retrieved communication queue entry |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "F8B463306703A63FF1CF93DD832CD68B",
"communication_queue_identifier" : { "number" : "9" },
"error_code" : "01",
"error_description" : "Communication definition is not configured."
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2014-11-11T15:51:19",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-09-15T13:02:04",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"error_code": "01",
"error_description": "Communication definition is not configured.",
"life_cycle_state": "REJECTED",
"communication":
{
"life_cycle_state": "COMPLETED",
"number": "70",
"id": "8152EA00439301ECC2FB57F2001E5433",
"contact_information":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Kyriakos",
"name": null,
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "87878000",
"id_issued_by_country": null,
"industry": null
}
}
},
"number": "9",
"id": "8AB1EBDE1854122C91B1EF8BD344BF62",
"communication_queue_external_system": null
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"communication_queue_identifier" : { "number" : "10" },
"error_code" : "01",
"error_description" : "Communication definition is not configured.",
"fields_set":"number,id,communication"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"communication": {
"life_cycle_state": "COMPLETED",
"number": "14",
"id": "D0C1DE5D9D2566EC6A26A45D5DFE899F",
"subject": "#activity.number",
"contact_information": {
"last_name": "Clark",
"middle_name": "S.",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mrs",
"first_name": "Kathy",
"type": "PERSON",
"id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
"name": null,
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "88996633",
"passport_number": "4564455",
"industry_sector": null,
"name_day": {
"month": 1,
"day": 1
},
"date_of_birth": {
"month": 1,
"day": 1,
"year": 1980
},
"id_number": "87878000",
"industry": null,
"id_issued_by_country": null
}
}
},
"number": "10",
"id": "E970FDFD76788C14FCC87DF5A71AECC7"
}
}