Agent
Create Agent API
The following is the list of expected error codes while creating an agent for RCS Agent:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS904 | Required fields are missing. | Missing Required Fields. |
| 400 | RCS904 | Fields with invalid format are passed. | Invalid Field Format. |
| 400 | RCS904 | RCS Agent creation Failed. | Invalid Allowed Values. |
| 400 | RCS904 | Fields with invalid format are passed. | Invalid Email Format. |
| 400 | RCS904 | Fields with invalid format are passed. | Invalid URL Format. |
| 400 | RCS904 | Fields with invalid format are passed. | Invalid Image URL Format. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 400 | RCS701 | Invalid json format passed. | Invalid JSON. |
| 405 | RCS405 | Method not allowed. | Method Not Allowed. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal Server Error. |
Get Agent by Agent Number API
The following is the list of expected error codes while getting agent details by agent number:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS904 | Unable to fetch RCS Agent details. | Missing Agent Number. |
| 400 | RCS904 | Unable to fetch RCS Agent details. | Agent Not Found. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal Server Error. |
Get All Agents API
The following is the list of expected error codes while getting all agents' detail:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS904 | Unable to fetch RCS Agent details. | No Agents Found. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal Server Error. |
Update Agent API
The following is the list of expected error codes while updating an agent:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS904 | Cannot modify restricted fields during update. | Restricted Feilds update attempt. |
| 400 | RCS904 | Required fields are missing. | Missing Required Fields. |
| 400 | RCS904 | Fields with invalid format are passed. | Invalid Field Format. |
| 400 | RCS904 | RCS Agent creation Failed. | Invalid Allowed Values. |
| 400 | RCS904 | Fields with invalid format are passed. | Invalid Email Format. |
| 400 | RCS904 | Fields with invalid format are passed. | Invalid URL Format. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 400 | RCS701 | Invalid json format passed. | Invalid JSON. |
| 405 | RCS405 | Method not allowed. | Method Not Allowed. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal server error. |
Delete Agent
The following is the list of expected error codes while deleting an agent:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS904 | Failed to delete Agent. | Missing Agent Number. |
| 400 | RCS904 | Failed to delete Agent. | Agent Not Found. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal Server Error. |
Submit Agent Verification API
The following is the list of expected error codes while submitting an agent for verification:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS904 | Agent verification submission failed. | Missing Agent Number. |
| 400 | RCS904 | Agent verification submission failed. | Invalid Form Data. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 405 | RCS405 | Method not allowed. | Method Not Allowed. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal Server Error. |
Get Agent Verification Status API
The following is the list of expected error codes while submitting getting an agent verification status:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS914 | Agent verification was unsucessful. | Missing Agent Number Query. |
| 400 | RCS914 | Agent verification was unsucessful. | Verification Status Not Found. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 405 | RCS405 | Method not allowed. | Method Not Allowed. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal Server Error. |
Register Tester API
The following is the list of expected error codes while registering a tester:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS904 | Tester registration failed. | Missing Required Fields. |
| 400 | RCS904 | Tester registration failed. | Missing Phone Number. |
| 400 | RCS904 | Tester registration failed. | Missing Agent Number. |
| 400 | RCS701 | Invalid json format passed. | Invalid JSON. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 405 | RCS405 | Method not allowed. | Method Not Allowed. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal Server Error. |
Get Testers by Agent API
The following is the list of expected error codes while getting testers by agents:
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | RCS904 | Tester details not found. | Missing Agent Number Query. |
| 400 | RCS904 | Tester details not found. | No Testers Found. |
| 400 | RCS601 | RCS Channel is not enabled for this User. | RCS Not Enabled. |
| 405 | RCS405 | Method not allowed. | Method Not Allowed. |
| 500 | RCS502 | Internal Gateway Error. | Gateway Error. |
| 500 | RCS500 | Internal server error. | Internal Server Error. |
Updated about 4 hours ago