...
| Code Block | ||
|---|---|---|
| ||
{
"records": [
{
"bLastResultMailbox": null,
"bPhoneNumber3Invalid": null,
"bPhoneNumber4Invalid": null,
"Company": "Company",
"ExternalSystemLink": "http://test.external.link/",
"Email": "Email",
"LastAcdAgentEndReasonsID": null,
...
"PhoneNumber3LastAcdAgentEndReasonsID": null,
"Tag": "Tag"
}
],
"count": 1,
"status": 200
} |
Delete a Dialler Contact by ID
This function deletes a dialler contact including all related data by ID.
URL
| Code Block |
|---|
DELETE {baseURL}/dialler/contacts/contact/{DiallerContactsID} |
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| DiallerContactsID | URL | Integer | The ID of the dialler contact to delete. |
Responses
If the request is performed, 200 OK is returned.
If the contact does not exist, 404 Not Found is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the status code.
Field | Type | Data |
|---|---|---|
| status | Integer | The return code (also provided by the http status code). |
Delete a Dialler Contact by UserData
This function deletes a dialler contact including all related data by providing the UserData for the record to delete.
Note, if more than one record contains the same user data, the first one found in the database will be deleted. It is not possible to determine which contact this will actually be.
URL
| Code Block |
|---|
DELETE /dialler/contacts/contact?userData={userData} |
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| userData | Query | String | The UserData of the dialler contact to delete. |
Responses
If the request is performed, 200 OK is returned.
If the contact does not exist, 404 Not Found is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the status code.
Field | Type | Data |
|---|---|---|
| status | Integer | The return code (also provided by the http status code). |
Lock a Dialler Contact by ID
This function locks a dialler contact by ID.
URL
| Code Block |
|---|
PATCH {baseURL}/dialler/contacts/contact/{DiallerContactsID}/lock |
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| DiallerContactsID | URL | Integer | The ID of the dialler contact to lock. |
Responses
If the request is performed, 200 OK is returned.
If the contact does not exist, 404 Not Found is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the status code.
Field | Type | Data |
|---|---|---|
| status | Integer | The return code (also provided by the http status code). |
Lock a Dialler Contact by UserData
This function locks a dialler contact by UserData.
Note, if more than one record contains the same user data, the first one found in the database will be locked. It is not possible to determine which contact this will actually be.
URL
| Code Block |
|---|
PATCH {baseURL}/dialler/contacts/contact/lock?userData={userData} |
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| userData | Query | String | The userData of the contact to lock. |
Responses
If the request is performed, 200 OK is returned.
If the contact does not exist, 404 Not Found is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the status code.
Field | Type | Data |
|---|---|---|
| status | Integer | The return code (also provided by the http status code). |
Unlock a Dialler Contact by ID
This function unlocks a dialler contact by ID.
URL
| Code Block |
|---|
PATCH {baseURL}/dialler/contacts/contact/{DiallerContactsID}/unlock |
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| DiallerContactsID | URL | Integer | The ID of the dialler contact to lock. |
Responses
If the request is performed, 200 OK is returned.
If the contact does not exist, 404 Not Found is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the status code.
Field | Type | Data |
|---|---|---|
| status | Integer | The return code (also provided by the http status code). |
Unlock a Dialler Contact by UserData
This function unlocks a dialler contact by UserData.
Note, if more than one record contains the same user data, the first one found in the database will be unlocked. It is not possible to determine which contact this will actually be.
URL
| Code Block |
|---|
PATCH {baseURL}/dialler/contacts/contact/lockunlock?userData={userData} |
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| userData | Query | String | The userData of the contact to lock. |
Responses
If the request is performed, 200 OK is returned.
If the contact does not exist, 404 Not Found is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the status code.
Field | Type | Data |
|---|---|---|
| status | Integer | The return code (also provided by the http status code). |
...