Users
Updated
by
RM
General
Protocol | HTTPS |
Port: | 443 |
Method: | POST only |
Return List of Matching Agent Names and ID numbers
URL | https://api.pay-tel.co.uk/PTAdmin/API/Agent/GetAgents.aspx | |
ClientID | Integer | Required |
Password | String | Required |
AgentSearch | String | Optional |
Create or Update Agent
URL | https://api.pay-tel.co.uk/PTAdmin/API/Agent/CreateUpdateAgent.aspx | |
clientid | Integer | Required |
password | string | Required |
agentid | integer (must be unique) | Required |
agentname | string | Required |
agentpassword | string | Required |
agentprimaryext | string | Optional |
agentsecondaryext | string | Optional |
agentemailaddress | string | Optional |
agentresetpassword | bool | Required |
Remove Agent
URL | https://api.pay-tel.co.uk/PTAdmin/API/Agent/DeleteAgent.aspx | |
ClientID | Integer | Required |
Password | String | Required |
agentid | Integer | Required |
General Status Response Codes
Value | Description |
0 | Success |
-1 | Failed to Authenticate |
-2 | IP Address is not recognised |
-3 | Invalid Method of Access, Post Requests Only |
-4 | Parameters are Missing |
-7 | Https / Secure Connections only allowed |
-99 | Unknown Error |
-100 | API Specific Error |
API Specific Response Codes
Value | Description |
0 | Success |
-1 | The Agent ID does not exist |
-2 | Agent ID Was Invalid |
-3 | Invalid Value for Agent Name |
-4 | Invalid Value for Agent Password |
-5 | Invalid Agent Extension |
-6 | Invalid Agent Email Address |
-7 | Invalid Option for Reset Password |
-8 | Invalid Client ID |
-99 | There was an unknown error within the API |
