{ "item": [ { "id": "14722e38-6208-497f-bacc-8546e274ec36", "name": "OAuth2", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7a8df265-e446-42ef-bb66-d747245e9956", "name": "Generate API Token", "request": { "name": "Generate API Token", "description": { "content": "Authenticates your account credentials and returns a Bearer token required for all subsequent API requests. Include this token in the `Authorization: Bearer ` header on every call. Tokens expire and must be refreshed. Use the optional `ApiEndpoint` field to scope a token to a specific endpoint URL for tighter security.\n\n**What this does:** Returns a `token` string and `tokenExpiry` timestamp. Include the token as `Authorization: Bearer ` on every subsequent request. The optional `ApiEndpoint` field scopes the token to a single endpoint URL — a token scoped to `/v1.0/numbers/provision` will be rejected by any other endpoint. Re-authenticate from scratch when a token expires; there is no refresh mechanism.\n\n**Next steps:**\n- Use the token on any other endpoint — `POST /v1.0/numbers/provision`, `POST /v1.0/message/outbound`, etc.", "type": "text/plain" }, "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"\",\n \"AccountSecret\": \"\",\n \"ApiEndpoint\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cff456cc-af73-407d-a0df-2981cbf86c2e", "name": "Success — returns the Bearer token and expiry timestamp", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"abcdeghijklmnopqrstuvwxyz...................\",\n \"successful\": true,\n \"tokenExpiry\": \"05/02/2025 06:36:13 PM\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dd70deb-7fdc-494a-8379-ace633de526a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f0c1dba-bbb3-4f19-8921-0e2d438c2b34", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f625f9c-9690-47d8-881e-8171e7b14786", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82c23e4c-368c-413a-aba5-bafc3030e6fc", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4e4da87-5e87-43ac-be19-fed5733d7553", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d436f26-0bec-44ed-8e5a-09c8d167afac", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a037ba5-5fa2-4788-abe7-c5947fcf822d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526d3022-8d65-4acf-a5a3-7a7d1dbda890", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4890c22-82d9-4e7d-a174-39e085df5233", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1a5decf-4545-4a9e-ab6d-1bac93988b9a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "OAuth2", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountKey\": \"DID-1234567ab-1a2b-3cd4-...-...........\",\n \"AccountSecret\": \"abcdeABCdef...\",\n \"ApiEndpoint\": \"https://api.telegent.com/v1.0/numbers/provision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2eafd030-b832-4b16-ba21-15a84be175e8", "name": "AI Guardian", "description": { "content": "", "type": "text/plain" }, "item": [], "event": [] }, { "id": "f3bed96c-201b-40bc-a3b6-3e1a1145f18e", "name": "Accounts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2662980a-7913-40d6-9c21-a165c53f6c1c", "name": "List Message Routes", "request": { "name": "List Message Routes", "description": { "content": "Retrieve a list of all message routes configured in your account. Returns basic information about each route including MRID, name, and webhook configuration.\n\n**What this does:** Returns a list of message routes (`MRID-` IDs) configured on the account. Use this to find an existing route ID before provisioning a new number or updating a number's message configuration.\n\n**Next steps:**\n- Get full route details — `GET /v1.0/message/routes`\n- Create a new route — `POST /v1.0/message/routes`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2a2739c2-6d94-42a0-8cbc-be07e166adad", "name": "Success — returns a list of all message routes on the account", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountID\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"TotalRoutes\": 2,\n \"Results\": [\n {\n \"MessageRouteId\": \"MRID-ad0ff867-57dc-4aeb-80e9-9d18349080e9\",\n \"AccountID\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": false,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\"\n },\n {\n \"MessageRouteId\": \"MRID-ad0ff867-57dc-4aeb-80e9-9d18349080e9\",\n \"AccountID\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": false,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aef78ef-f5e5-40c3-b757-fb189ce70bff", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84235a49-e538-43a2-8190-5fe62e137fff", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "686e43f7-ca44-4480-975b-f12a1bb33b7f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "304adcac-f390-4488-ae5b-0a2b2d5b0efc", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c523780-5803-40fd-9527-79ec518106ab", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8af41e59-9534-4060-8248-807d0d892120", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07dae4b9-8225-4bbe-87ac-347c88291862", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb186b51-e1d0-4f10-8bfa-a40d67b4eaa2", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08630d3a-c7b4-4c47-82f1-4df1f2dc30dd", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c56207da-9757-4ddf-9c6a-2310ad64ab86", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5cfeadfb-6817-4a10-9bc3-4321050cc2ae", "name": "List Voice Routes", "request": { "name": "List Voice Routes", "description": { "content": "Retrieve a list of all voice routes configured in your account. Returns basic information about each route including CRID, name, and routing configuration.\n\n**What this does:** Returns a list of voice routes (`CRID-` IDs) configured on the account. Use this to find an existing route ID before provisioning a number with voice enabled or updating call routing.\n\n**Next steps:**\n- Get full route details — `GET /v1.0/voice/routes`\n- Create a new route — `POST /v1.0/voice/routes`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "AccountId", "value": "", "description": "string AccountId" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fe653191-43e1-47c2-9765-b70046e83312", "name": "Success — returns a list of all voice routes on the account", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountID\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"TotalRoutes\": 2,\n \"Results\": [\n {\n \"CallRouteStatus\": \"Active\",\n \"CallRouteId\": \"CRID-993804Ar09099\",\n \"AccountID\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true\n },\n {\n \"CallRouteStatus\": \"Active\",\n \"CallRouteId\": \"CRID-993804Ar09093\",\n \"AccountID\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SIP Trunk Secondary\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9454ecaa-9e69-4f97-8da4-d16de53d1055", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41f09542-967b-440c-8980-94c6cba532f7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd69977a-95f4-4065-8f06-8ae05a22f604", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b312153d-b62e-466e-814c-09d4da87d836", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3570c163-925b-4c70-ae34-63162cb723c8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a262eea8-6e00-4877-b686-469404f51ad5", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc82794e-4f91-4905-9d47-53d132387ddf", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5d13f9a-137e-419b-935f-db6dfeff4846", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19d1f9e3-1420-471b-9d3e-bdb2750e4d78", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc73a0b-93e8-43a6-9e00-86adc635989a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4cceccb-d342-4428-bdcc-2b75bfe1d8d9", "name": "Get Services", "request": { "name": "Get Services", "description": { "content": "Retrieve a list of all services available in your account. Use the optional Filter parameter to filter by service status (e.g., Active, Inactive).\n\n**What this does:** Returns a list of services available on the account. Services are the billable components that make up products and packages.\n\n**Next steps:**\n- Get service details — `GET /v1.0/services`\n- Create a service — `POST /v1.0/services`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Filter", "value": "", "description": "Filter by status (e.g., Active, Inactive, All)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "74aec76e-22bd-4663-aa3c-930f5442342e", "name": "Get Services List", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"TotalServices\": 1,\n \"Filter\": \"Active\",\n \"Results\": [\n {\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true,\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d44e39b-23e3-4d7f-830e-ead747ecf676", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de1b406f-c4fc-4949-b04c-56cf0b78d870", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb2b7445-a063-4eb3-ac2a-645ec330c659", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64b32319-5ba7-4545-977f-49603c833f9f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82d104a9-dd48-491d-9448-0c59348f47f2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7a2fb40-1c8d-4ef2-bba1-28fbdb0f4c4e", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23d0a0ac-5ce2-426e-83bb-4610e86579a3", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12117160-5dfc-4fc9-a15e-0f4ba807b202", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60bd3a53-b801-480e-a8eb-3aba0718e890", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72bdc817-29c1-4c1d-b32f-7fcf51c3bb22", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ece1cadb-1301-4aee-a401-6b0249bd0f29", "name": "Get Products", "request": { "name": "Get Products", "description": { "content": "Retrieve a list of all products available in your account. Use the optional Filter parameter to filter by product status (e.g., Active, All).\n\n**What this does:** Returns a list of products available on the account. Products define the base service capabilities that are bundled into packages.\n\n**Next steps:**\n- Get product details — `GET /v1.0/products`\n- Create a product — `POST /v1.0/products`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Filter", "value": "", "description": "Filter by status (e.g., Active, Inactive, All)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5a1c2d7e-50c8-47fd-b3aa-5527c6c5e299", "name": "Get Products List", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"TotalProducts\": 1,\n \"Filter\": \"All\",\n \"Results\": [\n {\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim 1.0\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": null,\n \"Type\": \"Type 1.1\",\n \"SubType\": \"1\",\n \"Cost\": 34.56,\n \"BillingFrequency\": \"1\",\n \"Active\": true\n },\n {\n \"ProductId\": \"PRID-93d4fb71-8574-42ee-abc6-4c54f8240743\",\n \"SKU\": \"eSim Vince 2.0\",\n \"Description\": \"Telegent eSim\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": null,\n \"Type\": \"esim\",\n \"SubType\": \"0\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"1\",\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79307260-b2e7-4169-acd0-df968d26dceb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c80c6e3a-a549-4873-9770-c05142e357ca", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a47111ab-b2bb-424e-a01f-125ebe550b37", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f35695a-3df1-4138-876d-3ae0d5b6ec67", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "973957dc-15fa-4005-8257-8b8ca1cf3fb6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1add2ea1-4ade-460a-8a18-845b367a0f7c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fb21342-2c45-4250-8f89-fa4669afc94d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0859ff9c-29b0-47ee-b8ee-2f902fffc2b1", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ec75e72-b393-4d84-9578-1673b0856a3c", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bb9e9a8-4052-4c1c-b3b9-58f327fd02cc", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76906871-a1a0-496c-ae6c-f83727371ca3", "name": "Get Packages", "request": { "name": "Get Packages", "description": { "content": "Retrieve a list of all packages available in your account. Use the optional Filter parameter to filter by package status (e.g., Active, Inactive).\n\n**What this does:** Returns a list of packages available on the account with their IDs, names, and pricing. Use this to look up a `PID-` before creating a subscription.\n\n**Next steps:**\n- Get package details — `GET /v1.0/packages`\n- Create a subscription — `POST /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Filter", "value": "", "description": "Filter by status (e.g., Active, Inactive, All)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "763c3865-1e3f-45d2-a085-0915564dc3cf", "name": "Get Packages List", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"TotalPackages\": 3,\n \"Filter\": \"Active\",\n \"Results\": [\n {\n \"PackageId\": \"PID-203740d8-6b19-42c6-b22e-e45611d9cade\",\n \"PackageName\": \"eSim 3\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"AggregatorId\": \"AGID-A49349FB-170E-44BF-B61E-DCC65A3FEA1A\",\n \"SubscriberId\": \"456789\",\n \"Type\": \"Type 2\",\n \"Price\": 34.56,\n \"Monthly\": false,\n \"Active\": true\n },\n {\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageName\": \"eSim 3\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"AggregatorId\": \"AGID-A49349FB-170E-44BF-B61E-DCC65A3FEA1A\",\n \"SubscriberId\": \"12345\",\n \"Type\": \"Type 1\",\n \"Price\": 12.34,\n \"Monthly\": true,\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "139d0be6-e3c0-4801-b4c4-49d7feef4eed", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e215558-e8ea-4e6b-9c5b-a6b041428e1d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ef2374e-f041-426a-a5a2-f06c09392a47", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d317dd9d-5978-42c6-af62-69c3e6329b30", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9413977e-00c6-4f4f-9730-5ed5f2d9547a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae3438ea-5d21-497c-a973-996a48c3385f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf3ca85e-a211-4e84-9c6f-0eae4fb15bfa", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65d09efc-7a90-4d6d-a1b5-e4dcd4206cd1", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ff746b9-6eda-424b-bb1b-5af7cf31ccd6", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcc88a7f-9dd2-420e-9acc-f74a88e089a7", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e79a48bc-62f4-4639-9752-655b0db87c77", "name": "Get Subscriptions", "request": { "name": "Get Subscriptions", "description": { "content": "Retrieve a list of all subscriptions associated with your account. Use the optional Filter parameter to filter by subscription status (e.g., Active, Inactive).\n\n**What this does:** Returns a list of subscriptions on the account with their IDs, package associations, and status. Useful for auditing which subscribers have active plans.\n\n**Next steps:**\n- Get subscription details — `GET /v1.0/subscriptions`\n- Create a subscription — `POST /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Filter", "value": "", "description": "Filter by status (e.g., Active, Inactive, All)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bdbe71a8-eb54-4eee-b05f-f9f1d7b5b8df", "name": "Get Subscriptions List", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"TotalSubscriptions\": 1,\n \"Filter\": \"Active\",\n \"Results\": [\n {\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97c68a21-add0-4c1b-b9b8-eea2a34146ac", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32963a01-cbcc-4cc8-8bf3-9424e2ae3e67", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a83345a-afe2-402a-8859-79df22bcc278", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fa8682f-ea16-4383-9794-78afcf5e820e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5d2b800-d7af-430a-bf1d-8d04ae200d14", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8393e826-1086-43d8-9b17-d2e36793ca59", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef0764b7-db84-4664-803a-ac54d7f4acb7", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e5ed65a-98f4-46a6-87c7-eef745eff3d0", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88ecf6eb-6e66-403c-857d-133de0048866", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a65e41d-ea8a-4c64-ab0c-a903ff56c333", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a9c43a6-e8eb-4910-8a08-062b1e5f37d2", "name": "Get Account's Workgroups", "request": { "name": "Get Account's Workgroups", "description": { "content": "Retrieve all workgroups associated with the authenticated account. Returns a list of workgroups with their IDs, names, and configuration status.\n\n**What this does:** Returns a list of workgroups configured on the account including their IDs, names, types, and active status. Use this to look up a `WG-` ID before attaching it to a voice route or schedule.\n\n**Next steps:**\n- Get full workgroup details — `GET /v1.0/workgroups`\n- Create a workgroup — `POST /v1.0/workgroups`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7ecfa433-0be9-4739-8a41-8ec4c2bd70b9", "name": "Success — returns a list of workgroups for the account", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Workgroups\": [\n {\n \"WorkgroupId\": \"WG-abc123\",\n \"Name\": \"Support Team\",\n \"Type\": \"ring\",\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c7c18c-e632-4f09-9331-420afff3c0d5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "673e2cc2-0f7c-40f7-975c-416088c48d8f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a759595d-bd7d-437b-9498-907e17db7dea", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd73ca10-4a64-4ac8-b207-00de8b30d9e3", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb6b991f-d575-431b-9de3-5570245f5ecc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43bc7ac1-8b47-4b02-abe2-c3798d4f8c3e", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96c1d057-c46a-4b69-b426-31b7693c2dc2", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e644e152-082f-4d76-b84d-5b45d37038f6", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb416300-2af8-4264-b265-5f707c4d0859", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9878c6b-bd39-4f9b-b332-7833dab1ac08", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7d43791-747e-45ea-b0c5-30486858f147", "name": "Get Account Details", "request": { "name": "Get Account Details", "description": { "content": "Retrieve details for a specific account. Accounts sit below a distributor in the hierarchy and contain subscribers along with their associated phone numbers and services. Returns the account name, total subscriber count, address details, and the parent distributor reference.\n\n**What this does:** Returns the account's name, contact info, billing and mailing addresses, and status. Use this to confirm account configuration or retrieve the `AID-` needed for subscriber and subscription calls.\n\n**Next steps:**\n- Update account details — `POST /v1.0/account/update`\n- View account's numbers — `GET /v1.0/numbers/inventory`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "AccountId", "value": "", "description": "(Required) Account ID to retrieve details for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "55b8b15b-64d0-4a7a-bad5-4ab7dbc939e5", "name": "Account Details Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"AccountName\": \"Telegent Account\",\n \"TotalSubscribers\": 16,\n \"BillingAddress\": {\n \"Street1\": null,\n \"Street2\": \"NULL\",\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n },\n \"MailingAddress\": {\n \"Street1\": null,\n \"Street2\": null,\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c407a93a-a35e-436e-a010-a5d51acda5b8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3fd4452-2b10-4d3d-ac56-66ec7ef77811", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "492e6c73-746b-40f2-99d1-2d743ab27b91", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6b58bae-810a-48c2-b976-d39197e2ea0b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "589cbbc9-e56b-4acb-8d4c-5d7d792cafcb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6985357-9375-4be8-99c6-29ea687da7c9", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adc2103a-44b5-4ef6-88ae-5aef579af7d2", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8adb9874-ae2e-4b46-97cd-018447d66a9d", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2955952c-1d7c-4ac1-9666-a9de7a42ae01", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "797ece77-ec53-41e7-a580-fa4c4dc9d06c", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ee2400b-785c-4754-be99-3501f4e41fa6", "name": "Create New Account", "request": { "name": "Create New Account", "description": { "content": "Create a new account with administrator email, billing, and mailing address information. Returns the newly created account details.\n\n**What this does:** Returns the new account's `AccountId` (`AID-`) and confirmation of the created details. Store the `AID-` — it is required when creating subscribers and subscriptions under this account.\n\n**Next steps:**\n- Create a subscriber under this account — `POST /v1.0/subscribers/create`\n- Assign packages — `POST /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"\",\n \"AccountAdmin\": \"\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6e8a180d-c76e-4c74-987d-89c22e6af2cc", "name": "Account Created", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"AccountName\": \"Telegent Account 3\",\n \"TotalSubscribers\": 0,\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": null\n },\n \"MailingAddress\": {\n \"Street1\": null,\n \"Street2\": null,\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf43de75-b597-4a6e-94f0-7ee793a471c4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8be2e36-fb66-441d-ad3c-5a97d01d5776", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87523f90-62e4-4663-aeec-e19e08f41be9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "305c48d6-e636-4600-a5cf-13784515affb", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28d3c9f5-1f64-418d-b185-d29372860abf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c55137ed-2cd4-477e-90ca-e7838b0e2b8a", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d15bc52a-271e-4f77-acdc-5a6aa68e9ce6", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bb8310b-f602-4be9-945f-bf57161a9a4c", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2347c9e6-a151-47c7-a96b-cbdbef60f557", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b6d923-d407-4f41-b657-34b09b810223", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3\",\n \"AccountAdmin\": \"jerome@joonto.com\",\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": \"USA\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c16297d-4f13-4bc8-bc6b-a548db995cd6", "name": "Update Account", "request": { "name": "Update Account", "description": { "content": "Update an existing account's information including name and address details.\n\n**What this does:** Returns the updated account record. Only the fields you send are changed; omitted fields retain their current values.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/account`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4b8d49f5-d49f-4588-8c0a-3f1a7688db11", "name": "Account Updated", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"AccountName\": \"Telegent Account 3\",\n \"TotalSubscribers\": 0,\n \"BillingAddress\": {\n \"Street1\": \"Street 1\",\n \"Street2\": \"Street 2\",\n \"City\": \"Heber\",\n \"State\": \"Utah\",\n \"Zip\": \"\",\n \"Country\": null\n },\n \"MailingAddress\": {\n \"Street1\": null,\n \"Street2\": null,\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83599066-1e53-44fd-9c26-0d1b0ca7e5ca", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53169abd-dfeb-48dc-8830-5eb6bf47fa79", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bcdb717-66d6-4847-bb5d-ae50420421d4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb030f56-1a88-4881-bd5e-3606b85b8ff7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40990a06-50e5-45df-b8ca-3c2bcccbd93b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45c25a4a-7fbf-4fe3-87c9-ec97a3d47393", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5caef056-5f56-4189-b285-34d0aff2e70e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48ec1f5f-cdb9-4cb7-9e90-045dcb05abf4", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60fe86bd-309b-4b65-b8c1-dd6c546daf1a", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09daf17b-a422-4099-86d5-c587e7dfedde", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountName\": \"Telegent Account 3.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be56ce5b-a47e-4369-9244-93e143d65f82", "name": "Get Account Schedules", "request": { "name": "Get Account Schedules", "description": { "content": "Retrieve a list of all schedules configured for your account.\n\n**What this does:** Returns a list of schedule IDs and names configured on the account. Schedules control business-hours routing for workgroups. Use this to look up a `SCH-` ID before attaching it to a workgroup.\n\n**Next steps:**\n- Get full schedule details — `GET /v1.0/schedules`\n- Create a schedule — `POST /v1.0/schedules`", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0d2ac80e-5afd-4e7f-a6f8-9fb7e5253664", "name": "Account Schedules List", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountID\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"TotalSchedules\": 2,\n \"Results\": [\n {\n \"ScheduleId\": \"SID-12345-abc-12345\",\n \"Name\": \"Business Hours\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"MondayStartTime\": \"8:00 AM\",\n \"MondayEndTime\": \"5:00 PM\",\n \"TuesdayStartTime\": \"8:00 AM\",\n \"TuesdayEndTime\": \"5:00 PM\",\n \"WednesdayStartTime\": \"8:00 AM\",\n \"WednesdayEndTime\": \"5:00 PM\",\n \"ThursdayStartTime\": \"8:00 AM\",\n \"ThursdayEndTime\": \"5:00 PM\",\n \"FridayStartTime\": \"8:00 AM\",\n \"FridayEndTime\": \"5:00 PM\",\n \"SaturdayStartTime\": \"\",\n \"SaturdayEndTime\": \"\",\n \"SundayStartTime\": \"\",\n \"SundayEndTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d422969-cf18-487f-89cf-da393518167d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f5230f6-e54f-44f4-af25-65886e573718", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "132c029a-96df-4f96-bd15-2312339e9218", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08f2b0b6-dcdb-43d1-a108-fd0dc268a949", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c08d042-9d3d-4d37-b56c-725fb4772903", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17f81aec-5c99-4932-8273-e61517b089d3", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "982eb73f-f8e8-4064-b65b-5d45fa5dbb05", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1e4d9e5-4041-4444-ab20-3acfb31e5c71", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22e3837b-8ebc-459b-96bb-af75c06902d2", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4d10969-6529-4380-9ed4-5c621d26a2f2", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8faf021b-9eac-45f1-9070-f6fef8bc0508", "name": "Get Account Webhooks", "request": { "name": "Get Account Webhooks", "description": { "content": "Retrieves all webhooks configured on the specified account, including their target URLs, HTTP methods, authentication settings, subscribed event types, and active status. Use this to audit webhook configuration or to locate a specific `WebhookId` for updates or deletion.", "type": "text/plain" }, "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "auth": null }, "response": [ { "id": "f0eef312-c0fd-4d69-ab60-424566129c8e", "name": "Success", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountId\": {\n \"value\": \"\"\n },\n \"WebhookUrl\": {\n \"value\": \"\"\n },\n \"Method\": {\n \"value\": \"\"\n },\n \"DataFormat\": {\n \"value\": \"\"\n },\n \"AuthenticationType\": {\n \"value\": \"\"\n },\n \"AuthenticationUsername\": {\n \"value\": \"\"\n },\n \"AuthenticationPassword\": {\n \"value\": \"\"\n },\n \"AuthenticationToken\": {\n \"value\": \"\"\n },\n \"SubscribedEvents\": {\n \"value\": \"\"\n },\n \"WebhookId\": {\n \"value\": \"\"\n },\n \"Active\": {\n \"value\": \"\"\n }\n },\n {\n \"AccountId\": {\n \"value\": \"\"\n },\n \"WebhookUrl\": {\n \"value\": \"\"\n },\n \"Method\": {\n \"value\": \"\"\n },\n \"DataFormat\": {\n \"value\": \"\"\n },\n \"AuthenticationType\": {\n \"value\": \"\"\n },\n \"AuthenticationUsername\": {\n \"value\": \"\"\n },\n \"AuthenticationPassword\": {\n \"value\": \"\"\n },\n \"AuthenticationToken\": {\n \"value\": \"\"\n },\n \"SubscribedEvents\": {\n \"value\": \"\"\n },\n \"WebhookId\": {\n \"value\": \"\"\n },\n \"Active\": {\n \"value\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf076f0-4ac0-4387-93e3-e0890aad851e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c279bc6-bee5-4798-bbfe-cd0e922d40b9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a2c8085-85e7-4d14-9015-b64fc9fbdc00", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4684a112-7bcd-4171-b16c-bfd892c21c03", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b93628a7-6afe-452e-b98c-4c1bbf6611f7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f01bc50-411d-458d-b133-5f69ce52110f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9ec24cb-ebb3-4fb7-a508-2885d1e3f85e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52eb8249-e18d-4471-b390-673fd2412706", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77457dfd-4773-4a5f-9e1b-a53b8229734b", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "964419c9-4a75-4664-9f6f-a1a4fc2777a4", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "account", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "78d722cb-d61c-4f08-938c-bea2da1a083a", "name": "Distributors", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ed2cf85b-6c5d-41e3-8df8-78ef8661ebe4", "name": "Get Accounts", "request": { "name": "Get Accounts", "description": { "content": "Retrieve a list of all accounts associated with the distributor. Returns account information including name, total subscribers, and address details.\n\n**What this does:** Returns a list of all accounts under this distributor including their `AID-` IDs, names, and status. Use this to enumerate accounts before making account-specific calls.\n\n**Next steps:**\n- Get account details — `GET /v1.0/account`\n- Create an account — `POST /v1.0/account/create`", "type": "text/plain" }, "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "561cdb7b-8209-4b1e-92f0-32a50101f957", "name": "Accounts Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"AccountName\": \"Telegent Account\",\n \"TotalSubscribers\": 16,\n \"BillingAddress\": {\n \"Street1\": null,\n \"Street2\": \"NULL\",\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n },\n \"MailingAddress\": {\n \"Street1\": null,\n \"Street2\": null,\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25459279-fe7a-4085-8e8b-cd639f8b384f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "463e2dc3-94f1-4e2c-9f49-797eb30d3052", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c465c99e-ce53-4b2a-83ee-8a602bc2fb2e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aea5de9a-3a0d-404a-94e1-0c3592a6540e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "831bb547-5842-4901-96da-7df3bfb9af27", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13fba46a-5344-4516-99d5-a15a56ae3158", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2dc6a70-a912-474e-9db6-b25d2ccfcaf7", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0117f5c0-c1f9-4b6c-97d8-8c8e12c409c8", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c3dd96a-05ea-46a1-8356-b38c1c3c4dfa", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a1ab704-461a-4bb4-ab7b-4fa9946fca91", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e99a23a-c114-408b-b4a3-3fa015fb6968", "name": "Get Subscribers", "request": { "name": "Get Subscribers", "description": { "content": "Retrieve a paginated list of all subscribers under the distributor. Returns subscriber details including ID, name, email, phone numbers, role, and associated account information.\n\n**What this does:** Returns a paginated list of all subscribers across all accounts under the distributor. Use `PageNumber` and `TotalPerPage` to page through large result sets. Each record includes the subscriber's `TSUID-` and account association.\n\n**Next steps:**\n- Get individual subscriber details — `GET /v1.0/subscribers/get`", "type": "text/plain" }, "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "PageNumber", "value": "1", "description": "Page number for pagination" }, { "disabled": false, "key": "TotalPerPage", "value": "10", "description": "Number of subscribers per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "20a49b7b-a805-4d29-a8c1-f6937cf0b5d0", "name": "Subscribers Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PageNumber\": 1,\n \"TotalSubscribers\": 75,\n \"Subscribers\": [\n {\n \"SubscriberId\": \"TSUID-3dd3c8a9-632e-4415-b790-563444ba01ab\",\n \"Name\": \"\",\n \"Email\": \"2025289874@telegent.com\",\n \"PhoneNumbers\": [\n \"+12025289874\"\n ],\n \"Role\": \"Subscriber\",\n \"Account\": null,\n \"Subscriptions\": []\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc7ed7d8-1eb2-4419-be6d-d1b4f496cab7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d8bf335-e3c0-4edd-8a89-fa852ff0d964", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be0a192-bf44-451c-b3b5-4ffd006082f5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf7ce5c6-e8ae-4986-b02d-f01fd6422bfb", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "011ee62e-20eb-4e7e-a6e4-f49c69e5541c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7627f78f-24c2-46b0-8f57-fe029cebbb83", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfd33343-0d6d-48ba-ab6f-c79aed4cfd5a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9a597aa-b992-4310-b1c7-aef9ac18fb93", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "982f8578-0fb9-496d-92f5-8b8638047364", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba619fde-d0a5-4958-bd93-75c3be8b50a6", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "1" }, { "key": "TotalPerPage", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a975ee99-bb0e-48bd-8275-971628a0bf56", "name": "Get Distributor Details", "request": { "name": "Get Distributor Details", "description": { "content": "Retrieve details for a distributor account. Distributors sit at the top of the account hierarchy and can create and manage multiple sub-accounts (AID-) and their subscribers. Returns the distributor's account key (DID-), secret, total accounts managed, and address information.\n\n**What this does:** Returns the distributor's name, contact info, billing and mailing addresses, and status. The `DID-` from this response is the top-level identifier used throughout the account hierarchy.\n\n**Next steps:**\n- View accounts under this distributor — `GET /v1.0/distributor/accounts`\n- Update distributor — `POST /v1.0/distributor/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "DistributorId", "value": "", "description": "(Required) Distributor ID to retrieve details for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cb6c2ef7-8f01-4bcd-b2d6-f0df35689a75", "name": "Distributor Details Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Account\",\n \"AccountKey\": \"AGID-2054FE47-A4CF-4AB1-87B5-123F6618E6D3\",\n \"Secret\": \"10400bad9272f89deab92512\",\n \"TotalAccounts\": 16,\n \"BillingAddress\": {\n \"Street1\": null,\n \"Street2\": \"NULL\",\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n },\n \"MailingAddress\": {\n \"Street1\": null,\n \"Street2\": null,\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91877030-3550-4f3d-aaff-6647f153cc3a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebe3c848-a3a1-4330-8776-ee43ec41d0cb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be2a6e58-2add-4c04-a9e3-b127a4e66466", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c183fa5b-dbdd-434c-8b49-0316754a5eab", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "924bdc47-6604-4034-8a6d-1e3cac702368", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e99792ec-a654-4438-a354-27e65729452e", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255bf399-25a9-41d9-9726-09cfa739d959", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca89c779-8572-47fd-93ca-89aa7f4f57ff", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64239080-106f-40e3-aa6f-7a693923cdc9", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfbc69fd-0e84-4dde-93f8-a593a36b2d74", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DistributorId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57c3db7a-dc5a-480f-81d0-3cd5ece73edf", "name": "Create Distributor", "request": { "name": "Create Distributor", "description": { "content": "Create a new distributor with billing and mailing address information. Returns the newly created distributor details including account key and secret.\n\n**What this does:** Returns the new distributor's `DistributorId` (`DID-`) and created record. The `DID-` is the root identifier for all accounts, packages, and products under this distributor.\n\n**Next steps:**\n- Create an account under this distributor — `POST /v1.0/account/create`", "type": "text/plain" }, "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cf43e1ef-0621-47c0-ac6d-f04496eea71f", "name": "Distributor Created", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Account 2\",\n \"AccountKey\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"Secret\": \"10400bad9272f89deab92512\",\n \"TotalAccounts\": 16,\n \"BillingAddress\": {\n \"Street1\": null,\n \"Street2\": \"NULL\",\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n },\n \"MailingAddress\": {\n \"Street1\": null,\n \"Street2\": null,\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc38877-b006-4adf-bffb-8b93d9d07ec9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a135df5-a3aa-4e76-8b2d-4a5c5b9e763f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea8a151-b3e1-4c4b-98a0-3dea7101850c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62baba5c-0f90-4c81-baf5-0d9a9704e0c6", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93ca42af-58d2-49f6-825c-bf8347446a42", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10dfb1e9-ff63-4192-92f8-24f4d616fa8e", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b46ae93f-9be7-467a-8a5b-8a372b95d799", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7df7b7d-4f1c-4900-9a85-c6475057a2c7", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f091a828-8cd2-4840-b6cd-606c422fdff0", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7fee216-82f3-4580-bf51-60590d5aca77", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorName\": \"Telegent Distributor 2\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c75c985-f22a-425e-b17c-7638bd41f8dd", "name": "Update Distributor", "request": { "name": "Update Distributor", "description": { "content": "Update an existing distributor's information including name and address details.\n\n**What this does:** Returns the updated distributor record. Only fields you send are changed; omitted fields retain their current values.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/distributor`", "type": "text/plain" }, "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"\",\n \"DistributorName\": \"\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ae386cf3-947e-4218-8ab1-5ed8efbfd620", "name": "Distributor Updated", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Account 2\",\n \"AccountKey\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"Secret\": \"10400bad9272f89deab92512\",\n \"TotalAccounts\": 16,\n \"BillingAddress\": {\n \"Street1\": null,\n \"Street2\": \"NULL\",\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n },\n \"MailingAddress\": {\n \"Street1\": null,\n \"Street2\": null,\n \"City\": null,\n \"State\": null,\n \"Zip\": null,\n \"Country\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12c435f2-d285-4e03-93dc-f973f51296d8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee3d53e8-d04a-43ca-a08d-f017cdc8abba", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64325283-307a-4999-822c-9ac24caecea3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "803af5ee-f9f8-4c01-aa2a-bb55bcfe6b2f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db2afb85-317e-4c49-909f-0afb394e2e29", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29a3190c-f6fd-4e37-a1d9-6ae24cd7facb", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "902aec84-e75b-4468-9286-686e029527b2", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ffbbe21-9cae-4f3d-a4f8-2eb2b204b8f2", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93d37bfa-2bad-4fbc-9bda-9dba1e5ddbda", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3705727e-e0b8-4bb2-b613-b094add97505", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributorId\": \"DID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"DistributorName\": \"Telegent Distributor 2.1\",\n \"BillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n },\n \"MailingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6643a29f-1a7a-4bf4-8cb6-5d57a68c8119", "name": "Get Distributor Product List", "request": { "name": "Get Distributor Product List", "description": { "content": "Retrieve the list of products associated with the distributor. Filter by status (All, Active, Inactive).\n\n**What this does:** Returns the list of products configured at the distributor level. Products defined here can be included in packages offered to accounts.\n\n**Next steps:**\n- Get product details — `GET /v1.0/products`\n- Create a product — `POST /v1.0/products`", "type": "text/plain" }, "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Filter", "value": "", "description": "Filter products by status" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3051fb15-755a-4b0a-b09d-18eda0248c4f", "name": "Products Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"TotalProducts\": 2,\n \"Filter\": \"All\",\n \"Results\": [\n {\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim 1.0\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": null,\n \"Type\": \"Type 1.1\",\n \"SubType\": \"1\",\n \"Cost\": 34.56,\n \"BillingFrequency\": \"1\",\n \"Active\": true\n },\n {\n \"ProductId\": \"PRID-93d4fb71-8574-42ee-abc6-4c54f8240743\",\n \"SKU\": \"eSim Vince 2.0\",\n \"Description\": \"Telegent eSim\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": null,\n \"Type\": \"esim\",\n \"SubType\": \"0\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"1\",\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9721a03b-987e-4b74-b6fd-6e0ce39db0fb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1450a187-60e5-48ce-bc16-08e857e5cb98", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea8e6e1e-f7e0-4044-8827-76c4b7ee4989", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79d5870c-1251-4bf6-8711-a279e03dc43c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee8eb990-19a3-4aa0-8262-7f4bf5c9bb80", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f7dcb48-0311-4c18-a5bf-d8633ce189c8", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9132769c-0672-4e5b-a689-6d297ea417b6", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0aa43ef-1975-42d4-b0b9-9f9d40c7fecf", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32d530a6-68af-4362-9d12-989d7d65d648", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11518bfe-5ba8-494a-9b13-d52b9126e16f", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3032c77-554f-4903-9ae0-4067746611d1", "name": "Get Distributor Package List", "request": { "name": "Get Distributor Package List", "description": { "content": "Retrieve the list of packages associated with the distributor. Filter by status (All, Active, Inactive).\n\n**What this does:** Returns the list of packages configured at the distributor level with their IDs, names, and pricing. Packages group products for subscription assignment.\n\n**Next steps:**\n- Get package details — `GET /v1.0/packages`\n- Create a subscription — `POST /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Filter", "value": "", "description": "Filter packages by status" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e7fed798-e317-4e38-83c1-7971e3497b95", "name": "Packages Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"TotalPackages\": 2,\n \"Filter\": \"Active\",\n \"Results\": [\n {\n \"PackageId\": \"PID-203740d8-6b19-42c6-b22e-e45611d9cade\",\n \"PackageName\": \"eSim 3\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"AggregatorId\": \"AGID-A49349FB-170E-44BF-B61E-DCC65A3FEA1A\",\n \"SubscriberId\": \"456789\",\n \"Type\": \"Type 2\",\n \"Price\": 34.56,\n \"Monthly\": false,\n \"Active\": true\n },\n {\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageName\": \"eSim 3\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"AggregatorId\": \"AGID-A49349FB-170E-44BF-B61E-DCC65A3FEA1A\",\n \"SubscriberId\": \"12345\",\n \"Type\": \"Type 1\",\n \"Price\": 12.34,\n \"Monthly\": true,\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94a1411a-8610-4f86-8772-76df48e6b9eb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b21295e6-7886-4100-80eb-dce9c51d018f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61180a7e-d674-4077-a115-0ea09a7c66ff", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0e0c8e4-325b-4ba0-bd8f-e8490eec53be", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65438493-8e9e-4972-8788-11997d1298f4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94895a4b-6af5-4b8b-b640-68ef1a0840c7", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91efc45c-f95e-46a6-bcb5-cc1dd87878e6", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f9d8e61-3a25-4647-8bc7-266147538b87", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27c2d290-fda1-4f05-a3cd-75aa0b3d0262", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e937d25d-0e9f-4d25-b0b6-51e642e444a3", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8feff66d-5ba3-4a9d-aced-be474f80b672", "name": "Get Distributor Subscription List", "request": { "name": "Get Distributor Subscription List", "description": { "content": "Retrieve the list of subscriptions associated with the distributor. Filter by status (All, Active, Inactive).\n\n**What this does:** Returns a list of all subscriptions under the distributor filtered by the optional `Filter` value. Use this for a distributor-wide view of active plans.\n\n**Next steps:**\n- Get subscription details — `GET /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Filter", "value": "", "description": "Filter subscriptions by status" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "84cde760-7efc-4e1c-ac2c-59518606da9e", "name": "Subscriptions Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"TotalSubscriptions\": 1,\n \"Filter\": \"Active\",\n \"Results\": [\n {\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"SID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e685839e-d6bb-4675-b2b6-36fba3fc98f7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d2eba7a-a1c6-4aed-a414-eca4886f2c6d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d11d3814-154b-4b83-9e4c-078f2cfd3a43", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c3cf83-e878-4960-84ff-08d7e86a885a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ddf4475-0c4d-4e1c-b6cc-66d4986214b8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df30c8ef-c9f6-4440-a1b5-e825adf8f0ab", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b3226b0-5c9f-4832-9cd6-b1518f183ede", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c758d637-97fe-4774-ac9f-4e6189df8a49", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbf19672-5c80-42d7-9ba9-88a97f01f0f1", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1317625-492d-458f-a840-ff319abb3676", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "distributor", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Filter", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "daa5f73c-923a-444a-bd1c-5e4bd67a01d5", "name": "Message", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "26830f91-5af8-4c16-848c-e80cae400430", "name": "Create Message Route", "request": { "name": "Create Message Route", "description": { "content": "Create a new message route to configure how inbound SMS/MMS messages are handled. Specify webhook URLs for message delivery, fallback URLs, and HTTP methods. Each route is identified by a unique MRID (Message Route ID).\n\n**What this does:** Returns the new route's `MessageRouteId` (`MRID-`). Store this ID — it is required when provisioning numbers and can be assigned to multiple numbers. The webhook URL you configure receives a POST for every inbound message on numbers using this route.\n\n**Next steps:**\n- Assign the route to a number at provision time — `POST /v1.0/numbers/provision`\n- Update route settings — `POST /v1.0/message/routes/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"\",\n \"MessageUrl\": \"\",\n \"MessageUrlMethod\": \"\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"\",\n \"MessageUsername\": \"\",\n \"MessagePasswordToken\": \"\",\n \"CallbackMessageUrl\": \"\",\n \"CallbackMessageUrlMethod\": \"\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": \"\",\n \"OutboundBypass\": \"\",\n \"IntelligentRouteEnabled\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1cfc7e69-e118-41b7-8047-eb16070b3e6c", "name": "Success — returns the newly created Message Route ID (MRID)", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageRouteId\": \"MRID-ad0ff867-57dc-4aeb-80e9-9d18349080e9\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": false,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3528262d-d38d-4654-ac16-0a36043f8b0c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daa87999-1954-4341-a13f-9e26ef90f9a2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55c2f6be-780d-4339-8015-22df43e0762e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2dda160-218c-4ea6-a6f0-9c80d87bb9f3", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28a4e1f6-74ee-471d-9151-dfa1490e48cc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a38425b7-51ab-4841-ad4c-63421493c9dc", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc24860c-73d6-4c10-acd1-782ef2b2fb3a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60c69876-0b3b-44f4-8732-f91f5bfb7fe8", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98940901-b183-4076-a627-4542752a1c0b", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8faac165-e846-436b-92d7-c5d34d7b1d4a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"POST\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"Basic\",\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": \"password\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dae9c322-cc3d-4adf-9142-6397afdd9de4", "name": "Message Route Details", "request": { "name": "Message Route Details", "description": { "content": "Retrieve detailed configuration for a specific message route using its MRID. Returns webhook URLs, HTTP methods, timeout settings, and associated phone numbers.\n\n**What this does:** Returns the full route configuration including webhook URL, HTTP method, authentication settings, and callback URL. Use this to confirm route settings before assigning it to a number, or to retrieve the `MRID-` for use in provisioning.\n\n**Next steps:**\n- Update route — `POST /v1.0/message/routes/update`\n- Provision a number using this route — `POST /v1.0/numbers/provision`", "type": "text/plain" }, "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "MessageRouteId", "value": "", "description": "The unique message route ID (e.g., MRID-xxxxx)" }, { "disabled": false, "key": "MessageRouteID", "value": "", "description": "string MessageRouteID" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "301eecfd-449d-4baf-9133-2911bd718f56", "name": "Message Route Details", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": null,\n \"CallbackMessageUsername\": \"admin\",\n \"CallbackMessagePasswordToken\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d96426ba-4047-4ae2-aff7-2fcd0c6bdd24", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f89d98a-9a60-413c-9e16-d924e7415948", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257e637d-86a7-40a8-977c-9a5dc97d1473", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fe59395-f204-470b-9590-bb1fd4f71b9e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d235bb0-005b-402e-9597-dfe0b54bde0d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7051bcd9-5d84-42f4-adb4-c0669c12efa6", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61f2d0a9-7eb3-49eb-9ddd-561be395f38a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "772a6bfe-af3e-40bb-98f5-8f5be312147b", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2e59cbe-e01e-4944-82f4-a2bda08acab2", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39a2d897-03f2-4d61-b9a4-0fa6bebc3d11", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "MessageRouteId", "value": "" }, { "key": "MessageRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5db628c3-7aab-46e6-a2cc-e3ad3a585c1f", "name": "Update Message Route", "request": { "name": "Update Message Route", "description": { "content": "Update an existing message route's configuration including webhook URLs, HTTP methods, and timeout settings. Changes apply immediately to all numbers using this route.\n\n**What this does:** Returns the updated route configuration. Only the fields you send are changed; omitted fields retain their current values. Changes apply immediately to all numbers using this route — no re-provisioning needed.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/message/routes`\n- View numbers using this route — `GET /v1.0/numbers/inventory`", "type": "text/plain" }, "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"\",\n \"RouteName\": \"\",\n \"MessageUrl\": \"\",\n \"MessageUrlMethod\": \"\",\n \"MessageRouteEnabled\": \"\",\n \"MessageAuthenticationType\": \"\",\n \"MessageUsername\": \"\",\n \"MessagePasswordToken\": \"\",\n \"CallbackMessageUrl\": \"\",\n \"CallbackMessageUrlMethod\": \"\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": \"\",\n \"OutboundBypass\": \"\",\n \"IntelligentRouteEnabled\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "962ee465-689f-4e35-bbdd-22ff05c52dc9", "name": "Update Message Route", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": null,\n \"CallbackMessageUsername\": null,\n \"CallbackMessagePasswordToken\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12184a09-09d1-4490-b2de-a17818c682f5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b6585da-8f60-482e-946a-60fca98a29c5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08b46920-5994-4272-bf47-ee7e80da9466", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a240a29c-300d-46e0-891e-1de068f6fb32", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bbfb667-1e12-4210-a037-5cca412f5f8d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26c79750-3194-4ff2-843e-7ad12ecbe770", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3cb1875-b9ce-42d6-8cee-ba8b97f88413", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afa61893-a611-4fe2-a37b-9039b2806cf8", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83c83450-6049-4c4c-bed0-83c46a42dc59", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbfa6bf5-5610-4cf4-b4dd-f59240d2d247", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-01711e7e-c158-4de7-831f-673ab9fdaaa9\",\n \"RouteName\": \"Main SMS Webhook\",\n \"MessageUrl\": \"https://apiendpoint.com\",\n \"MessageUrlMethod\": \"GET\",\n \"MessageRouteEnabled\": true,\n \"MessageAuthenticationType\": \"Basic\",\n \"MessageUsername\": \"admin\",\n \"MessagePasswordToken\": \"passwordORbearerToken\",\n \"CallbackMessageUrl\": \"https://apiendpoint.com\",\n \"CallbackMessageUrlMethod\": \"POST\",\n \"CallbackMessageAuthenticationType\": \"\",\n \"CallbackMessageUsername\": \"\",\n \"CallbackMessagePasswordToken\": \"\",\n \"InboundBypass\": true,\n \"OutboundBypass\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-eab92510-1040-45a5-bb9c-0bad927SDY878W\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "452adb77-d5bc-488e-88cb-13dc5cb6b6e9", "name": "Send Outbound Message", "request": { "name": "Send Outbound Message", "description": { "content": "**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Required:** Provisioned phone number with messaging enabled (`From` field) — `POST /v1.0/numbers/provision`\n\n---\n\nSend an outbound SMS or MMS message from your provisioned phone number. Supports single recipient messaging with optional media attachments for MMS. Returns a message ID for delivery tracking. All phone numbers must be in E.164 format.\n\n**What this does:** Sends an SMS or MMS message immediately and returns a `MessageId` for tracking delivery. The message is routed through the `MessageRouteId` associated with the `From` number. Check delivery status using the MessageId.\n\n**Next steps:**\n- Check message status — `GET /v1.0/message/filter`", "type": "text/plain" }, "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"From\": \"\",\n \"Body\": \"\",\n \"CampaignId\": \"\",\n \"Owner\": \"\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b0fb80de-68da-4a98-b1ce-31548d4743e2", "name": "Success — returns the Message ID (TMID) for delivery tracking", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageId\": \"TMID-00348008102307aK01\",\n \"Direction\": \"Outbound\",\n \"Type\": \"p2p\",\n \"CampaignId\": \"TCID-dsuhofh3882\",\n \"Cost\": 0.0045,\n \"Status\": \"Queued\",\n \"To\": [\n {\n \"Number\": \"+12016093801\"\n },\n {\n \"Number\": \"+12232233180\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Owner\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CreatedOn\": \"16:45:59 MST 2025-01-23\",\n \"MessageType\": \"mms\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": \"https://results2.com\"\n },\n {\n \"MediaUrl\": \"https://results.com\"\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": \"dkjjkdflajdfjo3ji3jjljfkjaskjfad\",\n \"BaseType\": \"audio/wav\"\n },\n {\n \"Base64\": \"dkjjkdflajdfjo3ji3jjljfkjaskjfad\",\n \"BaseType\": \"video/mpg\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f0cf37a-33e2-499a-a8b5-25ee8382df79", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d1ad062-26be-445d-b072-9b150b1aff20", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4130ed4b-bc96-4435-b0e0-7fd2ef9be3b4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "624b4d7b-87ac-4f6e-aba6-92995cf680aa", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b747c6e-ff68-418a-b3f2-78825174cbf9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6db8758-9009-42cc-b14a-eae9e0b176d6", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caf93e5d-94f6-49d7-b246-c5adc1653d19", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dec93c0-be2c-402d-bc17-5ed99aa70f18", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7ad158b-da10-4c5b-96d1-21d99df69433", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31c596e6-b1b1-45d8-9811-47580751dd28", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "outbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"To\": [\n {\n \"Number\": \"+18015737111\"\n }\n ],\n \"From\": \"+18018018011\",\n \"Body\": \"Hello there!!!\",\n \"CampaignId\": \"JCID-dsuhofh3882\",\n \"Owner\": \"+18018018011\",\n \"MmsMedia\": [\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n },\n {\n \"MediaUrl\": {\n \"value\": \"\"\n }\n }\n ],\n \"MmsBase64\": [\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n },\n {\n \"Base64\": {\n \"value\": \"\"\n },\n \"BaseType\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41bf641b-5444-418c-b9aa-0aeb15dcd3b8", "name": "Filter Messages", "request": { "name": "Filter Messages", "description": { "content": "Retrieve messages filtered by phone number with pagination support. Returns a list of inbound and outbound messages for a specific number.\n\n**What this does:** Returns a paginated list of messages for the given phone number. Returns message IDs, bodies, direction, status, and timestamps. Use this to review message history or confirm delivery for a specific number.\n\n**Next steps:**\n- Send a message — `POST /v1.0/message/outbound`", "type": "text/plain" }, "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "PhoneNumber", "value": "", "description": "The phone number to filter messages for (E.164 format)" }, { "disabled": false, "key": "Page", "value": "", "description": "Page number for pagination" }, { "disabled": false, "key": "Results", "value": "", "description": "Number of results per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e6668f43-f976-4c51-8d17-68c4f9ec89aa", "name": "Success — returns a paginated list of filtered messages", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Messages\": [\n {\n \"MessageId\": \"MSG-abc123\",\n \"From\": \"+11234567890\",\n \"To\": \"+10987654321\",\n \"Body\": \"Hello world\",\n \"Direction\": \"outbound\",\n \"Status\": \"delivered\",\n \"CreatedAt\": \"2025-05-01T12:00:00Z\"\n }\n ],\n \"Page\": 1,\n \"Results\": 25,\n \"Total\": 100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "771d47e7-9a51-4646-9eb3-12014c1e0482", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d927ecb7-a32d-4d94-9337-90b37e3ae3ad", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e873648a-c037-45ea-8f38-f448947dc65e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ecdb493-b0e8-407f-be4d-83242d1d3279", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81184b4e-f6ac-4cf6-8d00-2c2f9794ddc8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a394a5b-0755-4ae8-9ac2-af401a601d6e", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c409d7a6-f345-4590-988d-e6418d87e2e9", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0f3afd1-d97d-49de-833c-484bf17c0af9", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc2cd515-2703-4ca8-9bd7-493406c452c1", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57b5d186-4aaf-4944-91e1-42c3dfe4ec53", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "Page", "value": "" }, { "key": "Results", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c054103-5983-4af4-8d69-d8dc42106af5", "name": "Delete Message Route", "request": { "name": "Delete Message Route", "description": { "content": "Permanently delete a message route from your account. Phone numbers using this route will need to be reassigned to a different route before deletion. This action cannot be undone.\n\n**What this does:** Returns a confirmation of deletion. Numbers assigned to this route will lose their message routing — reassign them to a different route before deleting to avoid service disruption.\n\n**Next steps:**\n- Create a replacement route — `POST /v1.0/message/routes`\n- Update affected numbers — `POST /v1.0/numbers/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a48058d5-4f81-4e57-b78b-a55fe8a87084", "name": "Delete Message Route", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageRouteStatus\": \"Deleted\",\n \"MRID\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb105a22-05bf-4d76-baa0-382861a474d4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4c4de9-49cb-4997-be5c-209bbfc95a8d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b715247-bdb8-4b58-8ccb-7a23f3a610bb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28ce22f4-0616-4560-ba2c-739a0c02e39f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50c987a9-ad48-4219-9756-c8fdec2178ac", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "064b0a94-9316-4cfe-89b4-c2490c32a079", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c811722-5965-4a21-96ed-53b4e16464c0", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec111ec7-2e02-4e33-9822-61c7f7d525fc", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fef54df8-8ec6-47a3-8e9f-56480819086d", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9116abb3-ae64-459d-ad8b-995daa06ac44", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea0febd4-d77b-4f0b-bb71-e440c093131b", "name": "Report Device Delivery", "request": { "name": "Report Device Delivery", "description": { "content": "Submit a device-level delivery confirmation for an outbound message. This endpoint is used to record whether a specific message was successfully delivered to the recipient's handset, beyond carrier-level delivery receipts. Provide the MessageId returned from the Send Outbound Message endpoint.\n\n**What this does:** Records a device-level delivery receipt against an existing message. Use this when your application receives an on-device delivery confirmation and wants to update the platform's delivery status record for a message.\n\n**Next steps:**\n- View the updated message status — `GET /v1.0/message/filter`", "type": "text/plain" }, "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "60fb7d46-e937-41c3-b10c-91a1426d18de", "name": "Device Delivery", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageId\": \"TMID-00348008102307aK01\",\n \"DeviceDeliveryStatus\": \"Delivered\",\n \"DeliveredOn\": \"2025-05-14T22:21:08.2813656+00:00\",\n \"DeviceType\": \"mobile\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8283cd99-d7f8-4cd4-ae48-330bf394e5cc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425ef254-9e20-45f8-afad-076335de0ca8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dee38b44-334c-4619-9ef8-18b484b88b11", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "450b77a7-d7b7-480c-b712-9431c2754117", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19d9db2e-76be-4e3d-b318-3ae50d6a6923", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb2a168e-c17a-469e-ae54-7d60983f779e", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c07dcf-449a-408b-a88f-662e4e70e029", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cfa55d7-3f21-43c0-9d46-301430402f2e", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fe3abec-85bc-400b-987d-1163dbcf0252", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac8af423-7d29-4648-9ac7-5c331fc1525e", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "message", "device-delivery" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageId\": \"TMID-00348008102307aK01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "deb05ed9-2fce-4ab9-8892-ba076eb86f21", "name": "Numbers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9d0fe2b7-9e53-4b46-93a6-700bf50016eb", "name": "Search Available Numbers", "request": { "name": "Search Available Numbers", "description": { "content": "Search for available phone numbers before provisioning. Filter by area code or zip code, required capabilities (voice, SMS/MMS), and message type. Returns a paginated list of matching numbers. Run this step first to confirm number availability in your target area before calling the Number Provision endpoint.\n\n**What this does:** Returns a paginated list of available area code and zip code combinations that have numbers matching your criteria. This tells you which area codes have available inventory before you commit to a provision call. Each result includes an NGP code and area code to use in `POST /v1.0/numbers/provision`.\n\n**Next steps:**\n- Provision a number from the results — `POST /v1.0/numbers/provision`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"\",\n \"MessageEnabled\": \"\",\n \"VoiceEnabled\": \"\",\n \"MessageType\": \"\",\n \"PageNumber\": 1,\n \"AreaCode\": \"\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31f8721e-ab49-4634-9ad6-324ade7ce2cf", "name": "Success — returns a paginated list of available phone numbers matching your criteria", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"RequestId\": \"T-04139\",\n \"RequestDate\": \"2025-05-14T18:37:18.2408767Z\",\n \"NumberType\": \"mobile\",\n \"VoiceEnabled\": true,\n \"MessageEnabled\": true,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\",\n \"PageNumber\": 1,\n \"ResultsTotal\": 7700,\n \"AvailableNumberAreas\": [\n {\n \"NGP\": \"SAG\",\n \"AreaCode\": 993,\n \"Zipcode\": \"00601\"\n },\n {\n \"NGP\": \"AGP\",\n \"AreaCode\": 787,\n \"Zipcode\": \"00601\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28eb9e3b-7f3f-4822-9831-a8e4752944ec", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dd53319-f170-4250-bf97-55975d1f7fd6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5ee8837-28f5-48c0-ac81-7f660a9340e0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a081d8d7-6ae4-4738-9efc-28d355c461a8", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a55aba70-ae20-4ea4-b1a3-31e20e752575", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14af9bbb-1167-447c-bad0-86696abae253", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9d03d64-bc80-482a-8913-239a21cfb963", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7175b25a-5bf0-4380-ab01-8e6336894be4", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3fcba17-8806-4454-841f-363c6d462ed7", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e4d3188-d8a2-41d0-92b2-5f39ec033bc0", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": true,\n \"MessageType\": \"p2p\",\n \"PageNumber\": 1,\n \"AreaCode\": \"201\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6d86b79-37b5-4d5f-8714-8c6b7a6bae6d", "name": "Number Provision (Purchase/Order)", "request": { "name": "Number Provision (Purchase/Order)", "description": { "content": "**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Required:** Message Route ID (MRID) — `POST /v1.0/message/routes`\n- **Optional:** Voice Route ID (CRID) — `POST /v1.0/voice/routes` *(only needed if `VoiceEnabled: true`)*\n- **Optional:** Subscriber ID (TSUID) — `POST /v1.0/subscribers/create` *(to assign the number at provision time)*\n\n---\n\nPurchase and activate a phone number on your account. Before provisioning, ensure you have already created a Message Route (MRID) and Voice Route (CRID) — numbers provisioned without routes will have no call or message handling. Specify the number classification (`mvno` for full messaging and voice, `iot` for data and p2p messaging only), and required capabilities. Returns an OrderId for status tracking.\n\n**What this does:** Purchases and activates the number, returning an `OrderId`, the assigned phone number in E.164 format, a `PhoneNumberId` (`NID-`), and an eSIM QR code (if applicable). The `OrderId` can be used to track provisioning status.\n\n**Next steps:**\n- Check order status — `GET /v1.0/numbers/order`\n- Send a test message — `POST /v1.0/message/outbound`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"\",\n \"MessageType\": \"\",\n \"MessageEnabled\": \"\",\n \"VoiceEnabled\": \"\",\n \"ProductType\": \"\",\n \"DataEnabled\": \"\",\n \"MessageRouteId\": \"\",\n \"VoiceRouteId\": \"\",\n \"AreaCode\": \"\",\n \"ZipCode\": \"\",\n \"ICCID\": \"\",\n \"AssignedSubscriberId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "db35f903-b1e6-4f09-872e-48d1d81e5d7f", "name": "Success — returns the order ID, assigned phone number, and provisioning status", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"OrderDate\": \"2025-10-29T12:36:19.338438+00:00\",\n \"OrderId\": \"JNUOID-76ba71a8-d7a6-4489-b695-1ad363b8d596\",\n \"OrderStatus\": \"Complete\",\n \"PhoneNumberAssigned\": \"+18016025346\",\n \"PhoneNumberId\": \"NID-8bdf915a-ef65-46c9-8c66-96c98d42d9ca\",\n \"QRCode\": \"https://quickchart.io/qr?text=LPA:1$T-MOBILE.IDEMIA.IO$LX9G1-Q12VI-CIIWA-WAQIN¢erImageUrl=https://joonto.com/wp-content/uploads/2022/07/cropped-Joonto-2022-Square-Icon-Black-Background.png&ecLevel=H&format=png¢erImageSizeRatio=.3\",\n \"ZipCode\": \"84603\",\n \"ICCID\": \"12345678900987654321\",\n \"ErrorMessage\": null,\n \"SubscriberId\": \"TSUID-ac59a1f8-36b6-42cc-b124-c2aa29f7e3d2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61dd1b82-18fe-4324-9229-edeee3122d63", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "902f483c-f77e-4851-bbcd-b83b42b16489", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "046d11d9-7797-49b0-8344-400f01537091", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d9c695c-7311-4511-a324-a30f77ac1473", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b77bbac-d9ff-4e50-82e4-d8ec6885336e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd4e7192-bf50-44c9-9900-725570cc34a8", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc5b3c8c-1381-48a8-9aef-c4b0e0df77d5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "594352c5-357d-4d93-b527-08cfff7fded1", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d694163-6a08-4db0-9042-e9be490479bd", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "904f0b3b-0509-476f-9ae0-4f4f87188613", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "provision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"NumberType\": \"iot\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"VoiceEnabled\": false,\n \"ProductType\": \"Sms+Data\",\n \"DataEnabled\": true,\n \"MessageRouteId\": \"MRID-81dr9t90-....-....-....-..........\",\n \"VoiceRouteId\": \"CRID-5nov0yuy-....-....-....-.........\",\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\",\n \"ICCID\": \"8901240397190195850\",\n \"AssignedSubscriberId\": \"TSUID-1234567999\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "342f7b61-7852-4919-bc68-565d9dfea8da", "name": "Numbers - Port In", "request": { "name": "Numbers - Port In", "description": { "content": "**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Recommended:** Confirm the number is portable first — `POST /v1.0/numbers/portin/eligibility`\n- **Required:** Losing carrier name, account number, account password, and subscriber billing address\n\n---\n\nTransfer an existing phone number from another carrier into your Telegent account. Before submitting a port-in, run the Port-In Eligibility check to confirm the number can be ported. You will need the losing carrier name, account number, account password, and the subscriber's billing address for LNP (Local Number Portability) compliance.\n\n**What this does:** Submits the port request to the carrier and returns an `OrderId` with an initial status of `Pending`. Monitor the order using the `OrderId`. Port requests typically take 1-5 business days to complete.\n\n**Next steps:**\n- Track the port order status — `GET /v1.0/numbers/order`\n- Cancel if needed — `POST /v1.0/numbers/portin/cancel`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"\",\n \"CurrentCarrierName\": \"\",\n \"CurrentAccountNumber\": \"\",\n \"CurrentAccountPassword\": \"\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"Street2\": \"\"\n },\n \"ICCID\": \"\",\n \"TargetPortinClassification\": \"\",\n \"SubscriberName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "86e170a0-bb44-46c0-bd5f-4151d8dde94e", "name": "Success — returns the port-in order ID and initial status", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"OrderId\": \"JNOID-aabbde7a-....-....-....-............\",\n \"OrderDate\": \"2025-05-14T18:00:00.0000000+00:00\",\n \"Status\": \"Pending\",\n \"PhoneNumber\": \"+11234567890\",\n \"ICCID\": \"12345678900987654321\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75ec4846-4c2a-4815-92a6-c7e8d4be4868", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387ee2de-b88f-408a-b1c2-b0e5b70d806a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e04a012f-ae58-413f-bab6-369df7a75042", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17e1977b-20e4-4bef-b12f-58b4568a0261", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eb5dcbb-44c9-4cd3-9b41-73f53b410769", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d51efe6-2220-4b29-a0ec-84d0aa2b749a", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc426b8e-7dfd-4643-9041-aecc8a925a90", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8e859e2-091e-4fe8-81d2-ab4f6fb230a7", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "474f5fa0-a87e-41f1-ba61-daacb252174a", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd64486d-364e-4180-bf68-d2c4e3a16863", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortInNumber\": \"+11234567890\",\n \"CurrentCarrierName\": \"Company LLC\",\n \"CurrentAccountNumber\": \"4651234567\",\n \"CurrentAccountPassword\": \"0550\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Adddress Way\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\",\n \"Street2\": \"Suite 010\"\n },\n \"ICCID\": \"8901240397190557414F\",\n \"TargetPortinClassification\": \"mvno\",\n \"SubscriberName\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd150e90-7da5-44fa-aa07-8e36d58cda87", "name": "Numbers - Port In Eligibility", "request": { "name": "Numbers - Port In Eligibility", "description": { "content": "Check if a phone number is eligible for port-in before submitting a full port request. Returns carrier information and eligibility status.\n\n**What this does:** Returns a `Eligible` boolean, the number's current carrier, and number type. Run this before submitting a port-in to avoid failed orders. If `Eligible` is false, the `Message` field explains why.\n\n**Next steps:**\n- If eligible, submit the port-in — `POST /v1.0/numbers/portin`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"TargetClassification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3a349aa9-2b1c-4f36-b8e6-94a225f45cf4", "name": "Port In Eligibility", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+15555551234\",\n \"Eligible\": true,\n \"CurrentCarrier\": \"Example Carrier\",\n \"NumberType\": \"mobile\",\n \"Message\": \"Number is eligible for port-in\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "336cde1d-8d68-48c3-8c84-da8e9f4bb5aa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37ada3df-4725-4d7b-9394-093227e60677", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72f991c5-00c8-4ced-8780-5a93cc96895a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb3e2ac7-cc16-4183-8b35-7b1131e40bc7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f4ab597-fc80-47ef-8cad-2aee81699b82", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8921a42d-ddf0-4120-b1f4-f1624994fe6d", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ab41ca7-4135-46c1-bfaa-898cb45781a0", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "730033fe-d28f-4dd4-b5d0-102e6a3587f8", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08f6b896-82e7-49c8-9526-3278c57410ab", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "891c61f8-8daa-4c4e-9fd7-a8fd7ef67b55", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "eligibility" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+15555551234\",\n \"TargetClassification\": \"Mobile\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "deabe788-2108-4c1f-8182-6a3800f6da2f", "name": "Numbers - Update Port In", "request": { "name": "Numbers - Update Port In", "description": { "content": "Update an existing port-in order with new information such as carrier details, account credentials, or billing address before the port completes.\n\n**What this does:** Returns confirmation that the port-in order has been updated. Use this before the port completes if the carrier details or billing address provided were incorrect.\n\n**Next steps:**\n- Check order status — `GET /v1.0/numbers/order`\n- Cancel if needed — `POST /v1.0/numbers/portin/cancel`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"\",\n \"CurrentCarrierName\": \"\",\n \"CurrentAccountNumber\": \"\",\n \"CurrentAccountPassword\": \"\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"\",\n \"Street2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\"\n },\n \"PortInDate\": \"\",\n \"TargetPortinClassification\": \"\",\n \"SubscriberName\": \"\",\n \"ICCID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "59c69817-36e8-4777-b79a-3f2935263dcc", "name": "Update Port In", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"Status\": \"Updated\",\n \"Message\": \"Port-in order updated successfully\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222e1951-2225-4dde-b331-df6bb3484bea", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83bbca6c-1280-4852-9809-81bea37fdc0d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbc35a39-fe92-4ce3-a64b-dd274321348a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f571b6d4-700f-4284-b19a-dfd40d11d8a5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea7893d6-6ad4-4410-9782-c89268890b21", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ba4efd5-0fbb-41f8-ab96-3af24d900c5f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c9a261a-7d44-423d-97cc-898116567801", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bb13998-fcaf-4dfd-aff5-44596ae04833", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a40565-a0a7-4900-b43c-d195514669ab", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4965ab76-47a2-431a-b992-efa391b7432d", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"CurrentCarrierName\": \"Updated Carrier\",\n \"CurrentAccountNumber\": \"46512222\",\n \"CurrentAccountPassword\": \"0000\",\n \"CurrentBillingAddress\": {\n \"Street1\": \"123 N Address Way\",\n \"Street2\": \"Suite 010\",\n \"City\": \"Townsville\",\n \"State\": \"UT\",\n \"Zip\": \"84048\"\n },\n \"PortInDate\": \"2026-06-01\",\n \"TargetPortinClassification\": \"Mobile\",\n \"SubscriberName\": \"John Doe\",\n \"ICCID\": \"89014103211118510720\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "530237d6-94ec-4df3-8a13-5e158823db85", "name": "Numbers - Cancel Port In", "request": { "name": "Numbers - Cancel Port In", "description": { "content": "Cancel an existing port-in request using the order ID. This endpoint allows you to cancel a pending port-in order before it is completed.\n\n**What this does:** Returns the `OrderId` and a `Cancelled` status confirmation. Only pending port-in orders can be cancelled — orders in final states cannot be reversed.\n\n**Next steps:**\n- Submit a new port-in request — `POST /v1.0/numbers/portin`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0fc80488-4675-4e29-9203-b23a75e13694", "name": "Numbers - Cancel Port In", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\",\n \"Status\": \"Cancelled\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0369d6af-fb97-4d51-bb45-6e08a2659fba", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c72b6c4-b862-4ca4-b360-d91d0679afe8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b563fa9-9c66-40b2-8080-6477cd377583", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fa67397-b3ec-443e-bcc4-bc7e5873797a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e45ddbb4-73a8-4cb4-af75-bc0dfaf992ed", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6d9b477-9672-4d15-8ba4-6d1bb3109488", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e086979-fd7a-4f42-9545-a851c96a8a6e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd1d9786-7704-4e56-a134-b3adab00a0eb", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d659251d-bc7e-4931-bafc-8fa47aeaf299", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1151f94d-e08b-4ed0-915b-1034ebcdfce1", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portin", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OrderId\": \"JNUOID-6e3eb213-baf1-47bb-9db0-5d7d09d4b7b4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d9fbf3b-03ab-405b-a0c6-bf108b3b93f5", "name": "Numbers - Refresh NNID", "request": { "name": "Numbers - Refresh NNID", "description": { "content": "Refresh the Network Number Identifier (NNID) for a phone number. Use this when a number’s NNID becomes stale or needs to be re-synchronized with the carrier network.\n\n**What this does:** Triggers a re-sync of the number's Network Number Identifier with the carrier network and returns the refreshed `NNID` value. Use this when a number's carrier routing appears stale or incorrect after a number transfer.\n\n**Next steps:**\n- Confirm number state — `GET /v1.0/numbers`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c0958552-7c84-478c-8cfa-7eb03efd654d", "name": "Success — returns the phone number and refreshed NNID", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+11234567890\",\n \"NNID\": \"refreshed-nnid-value\",\n \"Successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0937c877-7c9f-4bba-812a-c55885fabbfc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e33ce4cf-272e-4386-84e3-a80add587fec", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c28d9ab7-e1c8-4da6-b8e5-36862134de50", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27005d82-24f8-4891-9b99-367cd6455a55", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f47cab25-56b6-4aa5-abce-4faf7d433bc9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3c1a7de-e6a5-417d-af94-5a66284dbd05", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11955a06-c2f3-43f2-96d4-4834ad5a0631", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e007f61-cf34-45a1-9f8e-2e2dd1e04cfc", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f48b9db7-bb65-44b6-89df-c2bed37c2a8f", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e15b05a-9e40-438c-9b97-2fdb682c2dfe", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "refresh-nnid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e19bd624-27ab-44d5-b3a1-da224a9a81b6", "name": "Get Voicemail Info", "request": { "name": "Get Voicemail Info", "description": { "content": "Retrieve current voicemail settings and configuration details for a specific phone number, including PIN status, notification email, and account association.\n\n**What this does:** Returns whether voicemail is active on the number, the notification email, subscriber name, and PIN status. Use this to confirm voicemail is configured before troubleshooting missed-call behaviour.\n\n**Next steps:**\n- Activate voicemail — `POST /v1.0/numbers/voicemail/activate`\n- Update settings — `POST /v1.0/numbers/voicemail/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "37ea7dc5-f862-4d24-b4d6-974e739c81e6", "name": "Success — returns voicemail configuration for the phone number", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+11234567890\",\n \"VoicemailEnabled\": true,\n \"Email\": \"user@example.com\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7389097d-bb69-4003-ae03-ad7f9b8f5426", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "856afcc0-841a-4c8a-b958-2d305e39e303", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9b1d20a-addd-4562-b896-93e74f3b017d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a1277f-252a-44ec-82cf-edf7549b717a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fc188b6-c3ba-4043-bb60-904b1410267e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17806c03-755b-48df-9c4f-6d5dfbd1ef38", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27fbf008-7333-4eb6-a6f3-aa1e6e83788e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c18eb7c-5547-4815-9ab2-d4207364e632", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a28b10f9-feca-4bf2-b94c-e27c2c094d81", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bde70278-d086-4326-90e7-32b53f41522c", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f90147fb-0c37-4e44-a79e-71a6862e4587", "name": "Activate Voicemail", "request": { "name": "Activate Voicemail", "description": { "content": "**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Required:** Provisioned phone number — `POST /v1.0/numbers/provision`\n\n---\n\nActivate voicemail for a phone number. Set a PIN, notification email, and subscriber name. Once activated, unanswered calls to this number will be directed to voicemail.\n\n**What this does:** Enables voicemail on the number and returns a confirmation. Once activated, unanswered calls are captured as voicemail and a notification is sent to the configured email. The PIN is required to retrieve messages.\n\n**Next steps:**\n- Confirm voicemail is active — `POST /v1.0/numbers/voicemail/info`\n- Update settings — `POST /v1.0/numbers/voicemail/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\",\n \"PIN\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9b1a1981-725c-46b4-97ad-f601c447c382", "name": "Success — returns voicemail activation status", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+11234567890\",\n \"VoicemailActivated\": true,\n \"Successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b12869e5-213b-4a60-a084-1e51e8d72ccf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4fe0cc7-d8bc-426d-8e47-91850fbd5e4c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e265d11-891d-4d53-8b49-471d89086b72", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09bf9946-ea24-488b-874f-fff13dba3c52", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "819433ae-fcc5-48d6-9a25-c6a1609482c2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dbdbb1c-dd7b-4b28-87b9-757eba2383cd", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a431bbf-b7f9-440a-84bd-ad58f1b75ff3", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bb7802e-f6d5-423d-b19c-09deda7d71dc", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2858969-bd51-4c7f-b974-234a95706ed2", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77d72abf-6a1f-4efa-841c-c4c12ad50a5a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"1234\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8509cfa-a2f7-46bd-a050-d00ffe2646a2", "name": "Update Voicemail", "request": { "name": "Update Voicemail", "description": { "content": "Update voicemail settings for a phone number including PIN, notification email, and subscriber name details.\n\n**What this does:** Returns confirmation that the voicemail configuration has been updated. Only the fields you send are changed; omitted fields retain their current values.\n\n**Next steps:**\n- Confirm the update — `POST /v1.0/numbers/voicemail/info`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\",\n \"PIN\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7d3d8530-62ef-4c7f-bd6c-8c113a1aa1e6", "name": "Success — returns update confirmation", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+11234567890\",\n \"Successful\": true,\n \"Message\": \"Voicemail settings updated\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30d52ad0-d291-4f7b-b3db-b191dd166a82", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec7bde61-ca9e-41c6-8771-78555c7b88e0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7832db6-9e0c-44ec-88ad-50e8a0c54d5f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ee9c89e-744c-4c52-8a4c-1f3037530d68", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd7b0afd-7f6b-414b-aba3-dab4d6530a30", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfccf4ba-eaae-4fd8-b43f-ea26ee001646", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52283a7c-2e9f-4fdb-a3d7-54613e22819f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35154c53-288a-483e-a060-55a43fad2bf3", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c46c534e-ef33-4ddc-bdcc-12d73a9cd9b1", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eb58b72-33c4-4003-bd1b-7948475cc637", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PIN\": \"5678\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"newemail@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a78e281-d0ba-4ed9-8cc6-746fa273ab6e", "name": "Delete Voicemail", "request": { "name": "Delete Voicemail", "description": { "content": "Remove voicemail configuration from a phone number. After deletion, the number will no longer have voicemail enabled and unanswered calls will not be captured.\n\n**What this does:** Removes voicemail from the number and returns a confirmation. Existing voicemail messages are deleted. Unanswered calls will no longer be captured after this call.\n\n**Next steps:**\n- Reactivate voicemail — `POST /v1.0/numbers/voicemail/activate`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "15255f1e-faa6-4f50-b2fd-a3ba70744dd8", "name": "Success — returns voicemail deletion confirmation", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+11234567890\",\n \"Successful\": true,\n \"Message\": \"Voicemail removed\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462166d1-5e56-42e1-b2df-1d8f4317c54a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56bb4797-af61-46f5-8cf7-e7be6e1e3fa5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2999776e-4278-4676-900f-0435d5c8cf6d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23692026-44a5-43d8-965f-bed3de6e1c51", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5301bb88-2b36-4477-a1fc-600f792e984f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12cd17cf-3628-47f6-b4c7-d19d67af711b", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed70035c-bb1d-4e90-b630-5bcdd9c83e04", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd436a82-f324-4288-b5db-ed7a84794c2b", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5e06ab4-29ff-4e88-b2e9-7e9472fff393", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72a49f7a-f102-4a2d-b10f-c9c0efacc64d", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "voicemail", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+11234567890\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4c21f98-778f-4d2a-9165-358e94cc6621", "name": "Numbers - Port Out", "request": { "name": "Numbers - Port Out", "description": { "content": "Assign a Port Out PIN to a phone number on your Telegent account. The PIN you set here is the PIN you will be required to provide when you later initiate a port-out transfer to another carrier.\n\n**What this does:** Saves the specified PIN against the phone number so it can be used to authorize a future port-out request.\n\n**Next steps:**\n- Track the port-out order — `GET /v1.0/numbers/order`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"\",\n \"PortOutPIN\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2ffd74a0-227c-48b9-bcd1-c7015808e48b", "name": "Numbers - Port Out", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"OrderId\": \"JNOID-dabada8a-....-....-....-.......\",\n \"OrderDate\": \"2025-05-14T18:00:00.0000000+00:00\",\n \"Status\": \"Pending\",\n \"PhoneNumber\": \"+11234567890\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a8d0dcf-b172-4a11-9af5-f9edb22afdb6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5939d8a5-1d3f-4c30-9258-c065dd2e94c2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d384e5ec-642b-44d8-910c-917353218575", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4617c5d2-a881-4548-a510-061417ab3aee", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8499386-1ef0-4d9d-92f7-7af82a777769", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d709b64-c5ef-47a5-b1a0-4271f1fbc1ca", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08e44026-a9c6-4546-9dfb-c6e5ff089211", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8d8bdd6-5131-4377-a394-e0241258351c", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f258d7e-d2d9-4bfb-ac94-617707821c66", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2609b962-9b2a-4908-abe9-26cb0684f885", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "portout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PortOutNumber\": \"+11234567890\",\n \"PortOutPIN\": \"1234\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00af2712-891e-4355-89ad-fc6a8fcacdda", "name": "Order ID Details", "request": { "name": "Order ID Details", "description": { "content": "Retrieve detailed information about a number provisioning order using the order ID. Returns order status, requested numbers, provisioning results, and any error messages.\n\n**What this does:** Returns the order status, order type (provision, portin, etc.), associated phone numbers, and any error message codes from the carrier. Multiple example responses are included showing common error states (account number required, number lock). Poll this endpoint after a provision or port-in to confirm completion.\n\n**Next steps:**\n- If status is Complete, the number is active — send a test message via `POST /v1.0/message/outbound`\n- If status is Error, review the `OrderStatusMessage` and retry the operation", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "OrderId", "value": "", "description": "The unique order ID to retrieve details for (e.g., JNUOID-xxxxx)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2a27b602-bca4-4078-996b-3debb37c1fe1", "name": "Order ID Details", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"OrderDate\": \"2025-12-08T00:12:08.89\",\n \"OrderId\": \"JNUOID-12390e1f-ef69-4d81-b97b-8d000e763ec9\",\n \"OrderStatus\": \"Error\",\n \"OrderStatusMessage\": \"8A-ACCOUNT_NUM_REQ_OR_INCORRECT\",\n \"OrderType\": \"portin\",\n \"PhoneNumbersOrdered\": [\n {\n \"Number\": \"+12815703894\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83098ec6-9ff9-43e7-808f-3e5f2505ed18", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "736794d2-8582-45dc-8c22-dd478589072b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "effe671b-5a84-42ff-a7e9-2337440ac45d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25773bb6-7e5b-4127-a928-f68ea1caaa42", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3690894-bbc9-4f39-8ae9-f702543f6af9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecad4fbc-4839-45f4-a930-ad3ec4b95399", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89a00ba8-970b-4bed-bd70-392d1c9007cd", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb2745f1-f522-4f3d-83ea-a91c4f240b4c", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28fc1f86-2e90-4f62-a6ea-1764d8aa591d", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9122cb3-6844-48bf-9024-25b0a38033a0", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OrderId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d893563-6cb1-4c49-806f-eaf8c83701a1", "name": "Numbers Inventory", "request": { "name": "Numbers Inventory", "description": { "content": "Retrieve a paginated list of all phone numbers currently provisioned in your account. Filter by number type, capabilities, and status. Includes detailed information about each number's configuration and services.\n\n**What this does:** Returns a paginated list of all provisioned numbers on the account. Each record includes the phone number, `NID-`, capabilities, assigned routes, subscriber, and status. Use this to audit your number pool or find a specific number's ID.\n\n**Next steps:**\n- Get details for a specific number — `GET /v1.0/numbers`\n- Update a number — `POST /v1.0/numbers/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "PageNumber", "value": "", "description": "Page number for paginated results (starts at 1)" }, { "disabled": false, "key": "Filter", "value": "", "description": "Filter string" }, { "disabled": false, "key": "TotalNumbersRequested", "value": "", "description": "TotalNumbersRequested int" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d98b28cb-6c3f-40d2-be6f-927baa0b85f5", "name": "Numbers Inventory", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"TotalResults\": 346,\n \"PageNumber\": 1,\n \"Filter\": \"Active\",\n \"PhoneNumbers\": [\n {\n \"Number\": \"+18015555555\",\n \"Tnid\": \"TNID-9772956561858\",\n \"OrderId\": \"TNOID-ddbaad7c-38c8-4cb4-bf0d-87ed9064f021\",\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"Status\": \"Active\",\n \"OriginalDatePurchased\": \"02/05/2023\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"Cnam\": \"ABC Corp\",\n \"QrActivationLink\": \"https://api.telegent.com/qr-activation-link\",\n \"SwapsRemaining\": 1,\n \"NextSwapResetDate\": \"2025-12-04T22:09:41.56\",\n \"ProductType\": \"Sms+Data+Voice\",\n \"PortOutPin\": \"1234\"\n },\n {\n \"Number\": \"+18015555556\",\n \"Tnid\": \"TNID-8772956561858\",\n \"OrderId\": \"TNOID-ddbaad7c-38c8-4cb4-bf0d-87ed9064f021\",\n \"NumberType\": \"mobile\",\n \"MessageEnabled\": \"true\",\n \"MessageType\": \"a2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": \"true\",\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"Status\": \"Active\",\n \"OriginalDatePurchased\": \"02/05/2023\",\n \"AssignedSubscriberId\": \"SID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b7d\",\n \"Iccid\": \"8901240397190555232\",\n \"Cnam\": \"ABC Corp\",\n \"QrActivationLink\": \"https://api.telegent.com/qr-activation-link\",\n \"SwapsRemaining\": 2,\n \"NextSwapResetDate\": \"2025-12-04T22:09:41.56\",\n \"ProductType\": \"Sms+Data\",\n \"PortOutPin\": \"5678\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5744e336-91ca-4730-aa78-4399ad543a28", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4da4f3d5-8676-4004-9aac-3c8219c5fa78", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76634fdc-0b17-441e-be8c-e9fbe21edfec", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "736cdb89-6bd2-4372-aaee-05743fecae23", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386c13af-193b-4fc6-bace-91f191e03442", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176bf749-a63a-4a84-8307-fd998bd4b608", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f0f5e9f-a478-4422-a802-0f02a6ee85e4", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af603e0b-6d30-4d8a-ba37-c948c410cc28", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9be92fe-a2a1-4d34-a4c4-fb9b28e2b137", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d65fbea-0420-427b-855c-2eef7ab604c7", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PageNumber", "value": "" }, { "key": "Filter", "value": "" }, { "key": "TotalNumbersRequested", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52c1acbd-5ff4-441b-a71c-d63ff74bcb81", "name": "Number Details", "request": { "name": "Number Details", "description": { "content": "Get comprehensive details for a specific phone number including its capabilities (voice, SMS, MMS, data), message routes, voice routes, classification, and current configuration.\n\n**What this does:** Returns the full configuration for a specific number: capabilities (voice, messaging, data), assigned routes, subscriber ID, ICCID, status, and number type. Use this to confirm provisioning details or look up a number's `NID-` for use in other calls.\n\n**Next steps:**\n- Update the number — `POST /v1.0/numbers/update`\n- Check data usage — `POST /v1.0/numbers/data-usage/info`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Number", "value": "", "description": "Phone number in E.164 format (e.g., +18015555555)" }, { "disabled": false, "key": "PhoneNumber", "value": "", "description": "Phone_Number string" }, { "disabled": false, "key": "ICCID", "value": "", "description": "ICCID string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1d77b054-fd6e-4c15-9565-c29c430a3dd4", "name": "Number Details", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Number\": \"+18018018011\",\n \"TNID\": \"TNID-kasjfljljlsadlfjlkhlkdhf\",\n \"OrderId\": \"TNOID-ijljqljildfiiuoieui\",\n \"NumberType\": \"Mobile\",\n \"MessageEnabled\": true,\n \"MessageRouteId\": \"MRID-6575d4d9-a10a-4b18-8936-4ac6dac73ac4\",\n \"VoiceEnabled\": true,\n \"Classification\": \"MVNO\",\n \"MessageType\": \"A2P\",\n \"VoiceRouteId\": \"T9992774\",\n \"Status\": \"Active\",\n \"OriginalDatePurchased\": null,\n \"AssignedSubscriberId\": null,\n \"Iccid\": \"8901240397190557414F\",\n \"Cnam\": \"Bob's Shake Shack\",\n \"QrActivationLink\": \"https://api.telegent.com/qr-activation-link\",\n \"SwapsRemaining\": 2,\n \"NextSwapResetDate\": \"2025-09-04T22:09:41.56\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3abda2e6-3987-49dc-978a-c7ef07855f15", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28bb95f6-65e2-4af1-b29c-472e7daa5899", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9162daf-bc8c-48ec-85ad-9a7de1ff5e6d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d151d47-39ec-4801-96d5-da4011b02600", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "413363dc-c09a-42f4-84cb-9bb5b5d87c8b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3b4d054-3d6c-4702-9acb-9a345da14bfd", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f082a42-6c53-4dfc-b1a3-456a36b2c0bd", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b73131a-8d5f-4f6f-bb90-47dc6006192d", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd7bd01d-185c-41a2-84a0-d59b81172308", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dd8a96d-2c97-43de-bac6-9cfe356a4590", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Number", "value": "" }, { "key": "PhoneNumber", "value": "" }, { "key": "ICCID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2434022c-b75c-4b32-b723-36dc209c33c6", "name": "Numbers Update", "request": { "name": "Numbers Update", "description": { "content": "Update configuration settings for one or more phone numbers. Modify message routes, voice routes, capabilities, and other number attributes. Changes take effect immediately.\n\n**What this does:** Returns confirmation of the updated number configuration. Changes apply immediately. You can change the message route, voice route, subscriber assignment, or number settings in a single call.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/numbers`\n- Check inventory — `GET /v1.0/numbers/inventory`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Number\": \"\",\n \"MessageEnabled\": \"\",\n \"MessageType\": \"\",\n \"Classification\": \"\",\n \"VoiceEnabled\": \"\",\n \"MessageRouteId\": \"\",\n \"VoiceRouteId\": \"\",\n \"AssignedSubscriberId\": \"\",\n \"Iccid\": \"\",\n \"CnamFirstName\": \"\",\n \"CnamLastName\": \"\",\n \"ProductType\": \"\",\n \"ForwardingNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "66bc5771-6344-405e-8fa6-14d759c2a86a", "name": "Numbers Update", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Number\": \"+18018018011\",\n \"Tnid\": null,\n \"UpdateOrderId\": \"JNUOID-9ac74103-bf27-474a-8a1a-9f4ff74af187\",\n \"UpdateOrderDate\": \"2025-05-14T22:21:08.2813656+00:00\",\n \"UpdateOrderStatus\": \"Complete\",\n \"MessageType\": \"p2p\",\n \"MessageEnabled\": true,\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"Iccid\": \"8901240397190557414F\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee80138d-9fe2-4c5d-8392-5c949d66ca5b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd2a6eb-9324-4ebd-9ee7-4104c2786554", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e2258a-5a9f-49f6-a60f-84912a9848b6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a6632b2-69d6-4936-aa66-bfc8202b2c9c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25a0ff4a-4e2b-4cd9-9270-dc56923ac2a8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8475355a-7786-40e3-8b34-68c0ac5dbca0", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66233e24-11eb-46d4-bed3-4a6fbc7ae361", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25f2b7f3-19af-47a3-85a9-5925fdc4b6f8", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7869b9f5-1fa9-4b4f-be53-c79b10fe5b63", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8082790-a81f-4088-b884-9b777bed971f", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Number\": \"+18018018011\",\n \"MessageEnabled\": true,\n \"MessageType\": \"p2p\",\n \"Classification\": \"MVNO\",\n \"VoiceEnabled\": true,\n \"MessageRouteId\": \"MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee\",\n \"VoiceRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe\",\n \"AssignedSubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"Iccid\": \"8901240397190556232\",\n \"CnamFirstName\": \"John\",\n \"CnamLastName\": \"Doe\",\n \"ProductType\": \"Data-Only\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "668d5912-6f71-4044-9505-5d49fc3a5303", "name": "Numbers Status", "request": { "name": "Numbers Status", "description": { "content": "Check the current status of one or more phone numbers including provisioning state, active services, and any pending changes or issues.\n\n**What this does:** Returns the status result for each number in the batch. Use action codes such as `Cancel`, `Park`, `Swap`, `Replace`, `Swap-Sim`, or `Activate` to change number lifecycle state. Each result includes the number, the action taken, and success or error status.\n\n**Next steps:**\n- Confirm new number state — `GET /v1.0/numbers`\n- View inventory — `GET /v1.0/numbers/inventory`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"\",\n \"EffectiveDate\": \"\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"\",\n \"ZipCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0788de21-f5ba-4138-b564-b4f1ddba690c", "name": "Numbers Activate", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"OrderId\": \"JNUOID-9df281cc-82ac-48fc-b8bf-edc0a5547f04\",\n \"OrderDate\": \"2025-05-15T18:20:58.5133475Z\",\n \"OrderStatus\": \"Complete\",\n \"ChangeType\": \"activate\",\n \"EffectiveDate\": \"2023-12-31T00:00:00\",\n \"Numbers\": [\n {\n \"Number\": \"+12016093801\",\n \"QrCode\": \"https://qrcodeimage.com\"\n },\n {\n \"Number\": \"+12016093802\",\n \"QrCode\": \"https://qrcodeimage.com\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "374704e1-1ceb-456e-8b65-e560f3d885ab", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a333ca9-2224-4499-a5f5-0ba12d9ec2dc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "309263bd-0653-416f-9c7e-1ae2ae0ba3cb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b972bf39-b1d2-446f-8669-eb69112519dd", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c79d648a-6c07-4735-939e-680e69f2d952", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1d40004-5e78-4487-8f61-9b57626b6d1c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2498cd9d-9dec-4b61-a7bd-28ea5153c4c1", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef5c08df-2b5c-4972-9bae-3faee77ab6df", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c38dddd2-7963-459e-8531-89556830bda2", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6876668f-6cf9-4b3b-b935-ddb687373135", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StatusChange\": \"replace\",\n \"EffectiveDate\": \"12/31/2023\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AreaCode\": \"201\",\n \"ZipCode\": \"84043\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6af1ea8-d5a0-44cc-a608-bdbec43d9ce5", "name": "Data Usage Limit", "request": { "name": "Data Usage Limit", "description": { "content": "**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Required:** Provisioned number ID (NID) with `DataEnabled: true` — `POST /v1.0/numbers/provision`\n\n---\n\nSet data usage limits, notification thresholds, and throttling parameters for IoT/MVNO numbers. Configure when subscribers are notified and at what usage level data speeds are throttled. **Important:** NotifyValue, ThrottleValue, and LimitValue must be in ascending increments and cannot be the same value (e.g., NotifyValue < ThrottleValue < LimitValue). Unless a `LimitValue` is specified, the default data limit is **20 MB**.\n\n**What this does:** Returns the updated data usage configuration for each number in the batch. Settings take effect at the next billing cycle or usage event. A `NotifyValue` triggers a notification webhook when usage reaches that threshold; `LimitValue` hard-caps usage; `ThrottleValue` reduces speed instead of cutting off.\n\n**Next steps:**\n- Confirm the new settings — `POST /v1.0/numbers/data-usage/settings`\n- Check current consumption — `POST /v1.0/numbers/data-usage/info`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"\",\n \"LimitValue\": \"\",\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": \"\",\n \"ThrottleValue\": \"\",\n \"ThrottleSpeed\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d892e46e-d884-48bf-8552-75b5a46ac8d3", "name": "Data Usage Limit Set", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Status\": \"Complete\",\n \"StatusMessage\": \"\",\n \"ValueUnit\": \"MB\",\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": \"+12016093801\"\n },\n {\n \"Number\": \"+12232233180\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ad4274a-9a9f-4572-a966-9f7e99d5f09a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e65fc57-2b9b-4fd4-a6ff-305f376f21ad", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4167840d-ad88-4eb8-82d7-6b550608f603", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32751754-0055-4972-aa52-5771c893c7c3", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83c33c75-a0df-44d6-aadd-a6882db09971", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3af96147-1181-4300-8b93-7c395c4466eb", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fdefcf1-e930-4e4e-8f76-eeec96cc7752", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fbbec73-97e5-4a65-933c-ff8640daa476", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e82cb6c-bfbf-4ebf-83f4-31fd1d895140", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9306313f-8e10-4aa7-ba7b-61c5a746e606", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ValueUnit\": \"MB\",\n \"LimitValue\": 20,\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"NotifyValue\": 10,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"1-mbps\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3b673f4-6fd0-412a-9e1f-8733f866be7e", "name": "Data Usage Settings", "request": { "name": "Data Usage Settings", "description": { "content": "Retrieve the current data usage settings (notify value, throttle value, limit value) for one or more phone numbers.\n\n**What this does:** Returns the current `NotifyValue`, `LimitValue`, `ThrottleValue`, `ThrottleSpeed`, and `ValueUnit` for each number. Use this to audit a number's data policy before making changes.\n\n**Next steps:**\n- Update data usage settings — `POST /v1.0/numbers/data-usage`\n- Check current consumption — `POST /v1.0/numbers/data-usage/info`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e41f60e-1e7c-4ad6-83b5-525d10f58aa7", "name": "Data Usage Settings Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumbers\": [\n {\n \"Number\": \"+17064491796\",\n \"Status\": \"Success\",\n \"StatusMessage\": \"\",\n \"NotifyValue\": 14,\n \"LimitValue\": 20,\n \"ThrottleValue\": 15,\n \"ThrottleSpeed\": \"thr1024kbps\",\n \"ValueUnit\": \"MB\"\n }\n ],\n \"Status\": \"Complete\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16879eaa-91ef-44b4-a86a-ff4a2bcf31d1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42e1fd3b-46a9-4e74-b8fb-c6fd75756e30", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "113588f2-975c-4e71-b2c6-1d632da26cda", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9d869bc-f6e3-40a4-9caa-d770c4f1912c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6613744e-ad2f-46a5-80e8-af634474b84a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff627413-6f05-4606-a50b-43f2b39be98d", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86d4c96-8348-4086-bc35-a280b79f7d99", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a642e19-cc4c-4d9b-8b99-f5671728a458", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09223058-db86-47b3-be7e-90ef4ee0e8d6", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9b7b0f7-8c03-4790-b441-29c6a4f083d1", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83731e25-5f00-458d-a17a-cc315eb6b333", "name": "Data Usage Info", "request": { "name": "Data Usage Info", "description": { "content": "Retrieve real-time data usage information for one or more phone numbers, including amount used, remaining data, and current behavior (active, throttled, etc.).\n\n**What this does:** Returns current consumed data and remaining data for each number in the batch. Values are in the unit specified by `ValueUnit` (MB). Use this for real-time monitoring dashboards or to decide whether to adjust a number's data limit.\n\n**Next steps:**\n- Update data limits — `POST /v1.0/numbers/data-usage`\n- View current limit settings — `POST /v1.0/numbers/data-usage/settings`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0171eebb-d00e-4f40-ac0c-8e5785d65abe", "name": "Data Usage Info Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumbers\": [\n {\n \"Number\": \"+17064491796\",\n \"Status\": \"ACTIVE\",\n \"StatusMessage\": \"\",\n \"Used\": \"0 B\",\n \"Remaining\": \"20 MB\",\n \"CurrentBehavior\": \"Active\"\n }\n ],\n \"Status\": \"Complete\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41154dec-2230-45c1-8f95-5448e5d6ec9b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5614197-d4d8-485f-97ba-52118c36e1a0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e72e7a9-0066-4bf7-b2fb-f8f8e08328fb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fbea61f-fce2-4446-ae2f-bfa1ddf0b804", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ca3d7a8-29a4-4f86-b2ef-532cd0e1ae66", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50e0a2df-e67e-4ad3-baba-c2198ba88482", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "494420f8-e00e-46d5-9a8b-38da8c350897", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b56d08ec-94ce-4cdf-a05a-a8c134ad964f", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa9e52f9-fc22-4594-a5b6-a4e4ca8a5120", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab02c573-0d3b-4447-a01f-6089b9c0cf48", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b1e55ab-f87e-40f0-93fd-5c4318b21f46", "name": "Device Details", "request": { "name": "Device Details", "description": { "content": "Retrieve IoT device details associated with a phone number, including IMEI, device model, device name, and TAC. AccountId is required for Distributors managing multiple accounts.\n\n**What this does:** Returns IoT device metadata linked to the number including IMEI, device type, and network registration status. Use this to confirm a physical device is correctly attached to the SIM/number before troubleshooting connectivity.\n\n**Next steps:**\n- Update the number — `POST /v1.0/numbers/update`\n- Check data usage — `POST /v1.0/numbers/data-usage/info`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5f3548bc-52f2-4c6a-a693-cdc773bd5dbc", "name": "Device Details Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"PhoneNumber\": \"+12017540711\",\n \"NumberType\": \"IoT\",\n \"IMEI\": \"1234567890\",\n \"DeviceModel\": \"Apple\",\n \"DeviceName\": \"Apple iPhone 17\",\n \"TAC\": \"123556\",\n \"Status\": \"Success\",\n \"StatusMessage\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d381e1fd-678b-42ea-9e44-e1ca776132b3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13a5418a-87ad-475f-9f59-5a10c185bb80", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d510a18b-6ac7-4ee3-abf5-7b1fdda67c6a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae9b2ec2-edea-46ea-b7f0-02207f32e8b6", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23490532-b2b6-4e3d-8273-08f902be61f7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9326def-6bf1-4559-8993-6f9285c01837", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "575961a0-b875-4e13-9962-10040e891173", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6acd46d5-ee1d-4c0c-bcc7-3c42cc969a0f", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1890fd21-e874-4d16-b255-5c6b0fe9d6e4", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ceb4c82-e08e-4df6-9f5f-ce08cb450148", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "device-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12017540711\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11e84940-a38b-4850-90c3-93726571d7af", "name": "Data Usage Update Renewal Info", "request": { "name": "Data Usage Update Renewal Info", "description": { "content": "Configure the monthly or weekly data usage renewal cycle for one or more phone numbers. Use this endpoint to set the day usage resets, enable or disable auto-renew, and optionally zero out current usage immediately.\n\n**What this does:** Updates the renewal schedule anchored to each number's individual — this is not a global calendar reset. Set to zero out a number's current usage immediately without waiting for the next cycle.\n\n**Next steps:**\n- Confirm current usage after a reset — \n- Review configured thresholds — ", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": \"\",\n \"PeriodType\": \"\",\n \"RenewalDay\": \"\",\n \"ResetUsage\": \"\",\n \"PeriodValue\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb5464f6-dcd9-4de6-be9e-3a3bc3f7754d", "name": "Renewal settings updated successfully", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Status\": \"Complete\",\n \"StatusMessage\": \"\",\n \"PhoneNumbers\": [\n {\n \"Number\": \"+18014730876\",\n \"Status\": \"Success\",\n \"StatusMessage\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "959c73a6-159e-4e66-b12c-317f382d10a9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "244c4ef0-70ee-4616-91c4-7b97f8fa1b60", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebef3a02-f5aa-4373-a4bf-4ad6be8d2833", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4866edb-21f7-457b-be7f-cbc6b6d89fff", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68ca9305-0485-4be8-b64c-360a97f0f69a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16fe0e47-9ecc-4a60-9822-b70ae73f177f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90d2b3b7-bf1a-4ae2-b085-d8ee78ef9f97", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e0df1a1-6b81-4588-b793-d530ecd2306d", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "287149ca-cee9-4525-8417-fa59b4ce144c", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11dd0c5f-bb93-4877-abf9-41a869c9802b", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "data-usage", "update-renewal-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumbers\": [\n {\n \"Number\": {\n \"value\": \"\"\n }\n },\n {\n \"Number\": {\n \"value\": \"\"\n }\n }\n ],\n \"AutoRenew\": true,\n \"PeriodType\": \"M\",\n \"RenewalDay\": 1,\n \"ResetUsage\": false,\n \"PeriodValue\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87eb77f2-de27-4bf5-8efa-2e530deb1e3f", "name": "Cancel Port-in of a Number", "request": { "name": "Cancel Port-in of a Number", "description": { "content": "Sample request:\r\n\r\n POST /numbers/portin/cancel\r\n {\r\n \"OrderId\": JNUOID-247ba6b7-2de8-4eb9-xxxx\"\r\n }", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "86f7622f-eda6-4506-9ee6-130e2d78b1d7", "name": "Success", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fc2bd88-9466-43b8-b2da-353f8bdc341c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a15bc03-08d4-4198-b2c4-09f9d37e3ff0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57ce5e65-3169-4521-9fed-f25db1a3a472", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "954ba09d-649c-4ff3-85a9-9878e5857e31", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f313a88-ecdb-4543-9fb6-f9b703600158", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd337ed7-6073-4f35-8147-1bbc286041da", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f514b10a-7f2f-4774-9324-26670eb39151", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce1cdbed-f8d1-47d3-aa92-eed44d4eb356", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "982f89da-16a8-4ee4-aeba-1be8feec410f", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1220e6df-0cb6-427e-a351-5dc45f79c681", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "cancel-portin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "160275af-f21d-4df3-b50a-e68e02c61729", "name": "Numbers - Reactivate", "request": { "name": "Numbers - Reactivate", "description": { "content": "Restore a recently cancelled phone number back to active status on your account. Use this to recover a number that was deactivated in error, provided the cancellation window has not yet expired and the number has not been released back to inventory.", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "baa405e1-7785-40ea-aff0-d6ef55dc3083", "name": "Success", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"string\",\n \"AccountId\": \"string\",\n \"Status\": \"string\",\n \"StatusMessage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88974347-e569-44d3-a737-9b023aee569a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10fdc261-3118-4e8d-9993-a03edbececa9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59127227-84ac-4ccf-8ebc-491766622018", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99a847a7-4203-4766-b0e8-9e205a192b5a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9120ee63-5a8e-47a3-836c-e513ce155db9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5138d9b-cef1-44c6-ad2a-b09790560cf4", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c22b6d8c-4b2b-4a10-9b60-8b0a132719d7", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f44cc248-0726-4413-9738-37a428dcf957", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f013356-f778-4dd4-82e6-8aba3924056d", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ede2c1cf-3bf4-4f91-b6c4-bda8011950e8", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9dc75c14-944e-44d2-b6b9-074bce9e127a", "name": "Numbers - Get E911 Address", "request": { "name": "Numbers - Get E911 Address", "description": { "content": "Retrieve the E911 emergency address registered to a specific phone number. Returns the street address on file that will be dispatched to emergency services when a 911 call is placed from this number.\n\n**What this does:** Looks up the E911 address associated with the given phone number on your account.\n\n**Next steps:**\n- Update an E911 address — `POST /v1.0/numbers/e911address/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "PhoneNumber", "value": "", "description": "(Required) The E.164-formatted phone number to look up (e.g. +12345678901)" }, { "disabled": false, "key": "AccountId", "value": "", "description": "Account identifier (e.g. AID-xxxx). Required for Distributors managing multiple accounts." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c8237ad9-a007-47fa-833e-1cf06355a3ce", "name": "E911 address retrieved successfully", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+13852217924\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"E911Address\": {\n \"Street1\": \"2701 N THANKSGIVING WAY\",\n \"Street2\": null,\n \"City\": \"LEHI\",\n \"State\": \"UT\",\n \"Zip\": \"84048-6330\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c424da0b-47d1-4d5f-b4ac-f5e3d0445edc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6779eb26-7583-47b9-b9f2-9abfc58f3a5c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b07150-e48e-4c1a-a0a2-55f3e8f889b0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca8262e7-38f2-4a8f-a0bc-70d901d5b2e5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4a833c8-776c-46e6-b489-c54945105980", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4073c1c8-1dd0-4259-836d-7491bac99b38", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9e2260c-cf93-43f1-96ff-716ee75ca020", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c989983-c08c-4687-a716-b11378bd1671", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db8f8a38-7b17-42d8-b4b0-956c067778fe", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72777d33-ca54-44ac-84a2-10b34e90e0da", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PhoneNumber", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "558b248b-0ed0-48a1-9cf6-ff2371133685", "name": "Numbers - Update E911 Address", "request": { "name": "Numbers - Update E911 Address", "description": { "content": "Register or update the E911 emergency address for a phone number. This address is provided to emergency services when a 911 call is placed from the specified number. Ensure the address is accurate and matches a valid MSAG (Master Street Address Guide) location.\n\n**What this does:** Sets or updates the E911 service address associated with the given phone number.\n\n**Next steps:**\n- Verify the updated address — `GET /v1.0/numbers/e911address`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"\",\n \"Street1\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Zip\": \"\",\n \"AccountId\": \"\",\n \"Street2\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3a1b138a-5485-441e-8090-1177875efa89", "name": "E911 address updated successfully", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+12345678901\",\n \"Status\": \"Success\",\n \"StatusMessage\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e484f400-b179-4349-ab07-9b4799710f6c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58865aaf-9eca-4238-acf5-b5d5d0ee8bb0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac636b85-1726-450a-adad-bc744b70501f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0992bc4-a5c1-418c-a108-8e822d1e2d7e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9bb46bf-dd85-4f14-805c-d7b9f2dfaa29", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f0cd29a-204e-49eb-906c-28ca35a61423", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba57a960-29d5-4bbc-9691-f930eb7af088", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d7c5d28-2d8e-4e87-967f-50572e50c180", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68820155-fb72-414f-a088-b68df0d1ded1", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaf9634a-33b4-45f0-a86f-66a1a8521225", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "e911address", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PhoneNumber\": \"+12345678901\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"Street1\": \"Street 1\",\n \"Street2\": \"\",\n \"City\": \"Lehi\",\n \"State\": \"UT\",\n \"Zip\": \"84041\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbb8248f-d3d2-43f1-8b69-46b9c9b966cd", "name": "Numbers - Update MMS Settings", "request": { "name": "Numbers - Update MMS Settings", "description": { "content": "Enable or disable MMS (multimedia messaging) on a provisioned phone number. Use this to turn picture, video and group messaging on for a line, or to disable it while leaving SMS in place.\n\n**What this does:** Sets the MMS feature flag on the line and returns the resulting state. SMS is unaffected either way — disabling MMS does not stop the line sending or receiving text messages.\n\n**Reading the response:** `MMS` reflects the state of the line after the update (`Enabled` or `Disabled`). Check `Status` — `Success` means the change was applied; any other value means it was not, and `StatusMessage` carries the reason.\n\n**Next steps:**\n- Confirm the line's current service state — `POST /v1.0/numbers/status`\n- Review the account's message routing — `GET /v1.0/message/routes`", "type": "text/plain" }, "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"EnableMms\": \"\",\n \"PhoneNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "32c8c3b5-b04f-4459-861d-76206e365092", "name": "Success — returns the line's MMS state after the update", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\",\n \"MMS\": \"Enabled\",\n \"Status\": \"Success\",\n \"StatusMessage\": \"MMS settings updated successfully.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a28ae154-d0b4-4e1b-8a65-946b7fee787c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5d139e2-c0c9-4f01-b7d3-2137c8446d44", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2796d54b-57cd-467e-b608-51c5040dc49f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf1fc95e-b4f1-4cb6-ab29-3c35b25e92bc", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a7edb2d-b799-44f6-a108-2ecf28e3d754", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c52694b-982f-442a-ac56-3a36129e7415", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3a509c4-c188-4e95-852d-b0fc63965585", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc7c46f5-4f15-42d3-a2cc-81a7cef8e784", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b34135a9-a08b-4e21-9bc0-7b447ebf4f8f", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09a15240-d3d8-4db0-8c20-b975f6d93f32", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "numbers", "mms", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"EnableMms\": true,\n \"PhoneNumber\": \"+13156120726\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-xxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8e4eba34-1ff8-4622-af64-ff78aa406f55", "name": "Voicemail", "description": { "content": "", "type": "text/plain" }, "item": [], "event": [] }, { "id": "7d64baa1-04ed-4f2c-81f7-5f440dcdb119", "name": "Packages", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "cbce59ac-4c32-42ed-8a9b-c8ca595309f1", "name": "Get Package Details", "request": { "name": "Get Package Details", "description": { "content": "Retrieve detailed information about a specific package by its PackageId. Returns package name, type, price, billing frequency, and associated distributor information.\n\n**What this does:** Returns the package details including name, description, price, billing frequency, type, and status. Use this to retrieve the `PID-` needed when creating subscriptions or to audit package configuration.\n\n**Next steps:**\n- Create a subscription using this package — `POST /v1.0/subscriptions`\n- View items in the package — `GET /v1.0/packages/items`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "PackageId", "value": "", "description": "The unique package ID to retrieve details for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d999ac4c-8e6f-49d1-9b6f-c8c3ca63df2d", "name": "Package Details", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PackageId\": \"PID-203740d8-6b19-42c6-b22e-e45611d9cade\",\n \"PackageName\": \"eSim 3\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"AggregatorId\": \"AGID-A49349FB-170E-44BF-B61E-DCC65A3FEA1A\",\n \"SubscriberId\": \"456789\",\n \"Type\": \"Type 2\",\n \"Price\": 34.56,\n \"Monthly\": false,\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "582a6c78-2040-478d-86eb-eb9fd1af965f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e5c1ffa-64fe-4fc0-bb30-8ac50a76d36b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "716f3ece-6947-42f3-8f75-cf6d222bd7b2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b500c45e-2172-44f9-9bd0-caebc51cf8fb", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58be6f72-1f0e-4223-bc1d-eb2de39f79e4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c587601-a553-442e-927e-436420dfd89b", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0944a6aa-d70b-445a-ba25-9b08c55a1942", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fadf5bf-8817-4b2a-82fa-f024a09d8c24", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7011057e-f4b1-4204-8552-a38f41b425a0", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8c88592-70a6-41d4-bf3a-e57ff0050b9a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "149588b1-9000-4fca-bde4-22ad16b95a68", "name": "Create Package", "request": { "name": "Create Package", "description": { "content": "Create a new package with name, description, type, price, and billing frequency. Packages bundle products together for subscriber offerings.\n\n**What this does:** Returns the new package's `PackageId` (`PID-`) and full record. Store the `PID-` — it is required when creating subscriptions. Add products to the package using the items endpoints.\n\n**Next steps:**\n- Add items to the package — `POST /v1.0/packages/items/add`\n- Create a subscription — `POST /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"\",\n \"Type\": \"\",\n \"Price\": \"\",\n \"Monthly\": \"\",\n \"Description\": \"\",\n \"SubscriberId\": \"\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bc0b775f-dd7e-43b5-82a1-13755007efe9", "name": "Create Package", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PackageId\": \"PID-23bf4d8d-14bf-431b-88a4-9a214a87b58a\",\n \"PackageName\": \"Package 4\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"AggregatorId\": \"AGID-A49349FB-170E-44BF-B61E-DCC65A3FEA1A\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 100,\n \"Monthly\": true,\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c6248e9-f543-431e-9ec7-3011945278cd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d34e8753-71a6-46d9-bea3-02b402206a36", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b4df7b5-3ddd-4896-a253-0732a4615b39", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a123462-8f6e-4e43-8452-75768bd8ecd8", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c79a0e54-bda2-41ca-833c-a366d7f75184", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb441de0-6930-4be8-a981-e60de0deb95a", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "212a75eb-f057-4cd8-9ab5-3e631d061c8b", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0da8f48-998e-4225-ac2f-47ef48beca35", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d63c1cb7-73fc-4093-ac04-18a98a90c1b5", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6ad281b-e893-4cd1-bb05-934fcc42d9ba", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageName\": \"Package 10\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true,\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"PackageItems\": [\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n {\n \"ProductId\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"Monthly\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc46e599-9d8f-42d4-bfea-1e3b6e0a7278", "name": "Get Package Subscriptions", "request": { "name": "Get Package Subscriptions", "description": { "content": "Retrieve all subscriptions associated with a specific package. Returns subscriber details and subscription status for each subscription linked to the package.\n\n**What this does:** Returns a list of all active and inactive subscriptions for the package, including subscriber IDs and status. Use this before deleting a package to confirm there are no active subscriptions that would be affected.\n\n**Next steps:**\n- Delete a subscription — `POST /v1.0/subscriptions/delete`\n- Get subscription details — `GET /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "PackageId", "value": "", "description": "The package ID to retrieve subscriptions for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "eccc2c46-ce15-4673-a1be-a5b030c83db6", "name": "Package Subscriptions", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageName\": \"eSim 3\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"AggregatorId\": \"AGID-A49349FB-170E-44BF-B61E-DCC65A3FEA1A\",\n \"SubscriberId\": \"12345\",\n \"Type\": \"Type 1\",\n \"Price\": 12.34,\n \"Monthly\": true,\n \"Active\": true,\n \"Subscriptions\": [\n {\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"Active\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "750b48ff-1b57-4bb2-91c3-3ce1cb0a99cc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1be84dd-a5f0-4d09-9df8-97e83e95cb91", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25c0ba3e-c28f-42f5-a93e-83e7ab0eb79f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "522b2def-22e6-4fe0-8b68-9b76f746b408", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d5e815f-20dc-4519-bee2-4e81dcaf64a6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72b83cf5-a6c5-4c73-8d9c-a505defb8c33", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cd45def-f5af-4eda-a501-7cff09e06490", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "880ebd1f-5512-4e0a-8b77-f016e16ad87f", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87df5490-8d7c-49af-8e6c-4ba8a0f3df88", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "172477d5-9045-4669-90dd-a75987cdf553", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89737caf-805d-4301-8643-79ed08fab4f1", "name": "Update Package", "request": { "name": "Update Package", "description": { "content": "Update an existing package's name, description, type, price, or billing cycle. Changes apply immediately and affect all active subscriptions tied to this package. Use the PackageId (PID-) returned when the package was created.\n\n**What this does:** Returns the updated package record. Changes apply to the package definition immediately but do not retroactively change active subscriptions.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/packages`\n- View package subscriptions — `GET /v1.0/packages/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"Description\": \"\",\n \"SubscriberId\": \"\",\n \"Type\": \"\",\n \"Price\": \"\",\n \"Monthly\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "90d6347b-0b7c-4735-b61c-f767d32fc45b", "name": "Update Package", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 5 Updated\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"AggregatorId\": \"AGID-A49349FB-170E-44BF-B61E-DCC65A3FEA1A\",\n \"SubscriberId\": \"TSUID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 250,\n \"Monthly\": false,\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b618da64-c557-4a79-8faf-68c12c797ffb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de10d02a-bfba-44d0-b6e7-b59b4857c8e0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "567b896f-f9f4-492c-b829-da6c93c27530", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7abb06c-47e4-48f3-b65d-7541cbea615b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e02ddcdc-54d1-4084-84cd-4203ca8b9433", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5414ec9-5857-4dcb-8cfa-a557383d5504", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e089da03-bddb-4371-aba4-a0abea6f4c78", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "666add2f-8935-4409-96b4-71812c60cbeb", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfbcddf5-9347-4e87-a233-ee525c42b4fb", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf323e61-8485-4465-b050-a9a6eb835093", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageName\": \"Package 10\",\n \"Description\": \"Package 10 Description\",\n \"SubscriberId\": \"SID-A2AD6FB7-2D53-40CE-96E4-EBB7F7C54509\",\n \"Type\": \"sip\",\n \"Price\": 300,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63fe710b-c02a-4a1a-99be-ae7f69c12a59", "name": "Delete Package", "request": { "name": "Delete Package", "description": { "content": "Permanently delete a package by its PackageId. This action cannot be undone.\n\n**What this does:** Returns a deletion confirmation. Packages with active subscriptions cannot be deleted — cancel all subscriptions first.\n\n**Next steps:**\n- View current subscriptions — `GET /v1.0/packages/subscriptions`\n- Delete individual subscriptions — `POST /v1.0/subscriptions/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "56d1678c-57ed-48ea-8b79-0c58e2c9c5b4", "name": "Delete Package", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\",\n \"PackageStatus\": \"Deleted\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cb4c3a2-fe61-4d4a-965b-eb4d117422a4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d78499ec-cd22-45b3-83d4-63f864bc0235", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b983af6c-c50f-4616-a085-e48992a6f83a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e5dfaa0-deba-4797-b739-27512472848c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b561cc13-60ab-4988-a28d-d845faf2b358", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44d1f3e1-c243-4c41-b8a3-9c7e9e7140de", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03f493ad-a648-4943-8ea2-b75761e13b64", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70a42ea1-d90a-4991-af10-00c04a49109f", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0371b13d-574b-4bad-8300-98aec5ccc738", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6109d1e5-aef1-4d3e-b640-c4bfac4874c2", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-a56cf783-c249-42fa-bf52-529e5886cdd4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68a4ebc0-4f24-45a7-9271-663df97a964f", "name": "Get Package Items", "request": { "name": "Get Package Items", "description": { "content": "Retrieve all items (products) included in a specific package. Returns product details, pricing, and billing information for each item in the package.\n\n**What this does:** Returns a list of products included in the package with their prices and billing frequency. Use this to audit what services a subscriber will receive when assigned this package.\n\n**Next steps:**\n- Add a product to the package — `POST /v1.0/packages/items/add`\n- Remove an item — `POST /v1.0/packages/items/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "PackageId", "value": "", "description": "The package ID to retrieve items for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7e416fd6-7e57-4cd9-981b-5c2ea8912c36", "name": "Get Package Items", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"PackageItemId\": \"PIID-4efee842-16f0-4803-9780-8c3c30d19b74\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-9E4F3852-5405-E9FC-2FDF-7A0530B7D862\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"Type\": \"Type 3\",\n \"Price\": 1.12,\n \"Monthly\": false,\n \"Active\": true\n },\n {\n \"PackageItemId\": \"PIID-06ed24ae-a406-4788-97f7-531ab34ea0aa\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-9E4F3852-5405-E9FC-2FDF-7A0530B7D862\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"Type\": \"Type 4\",\n \"Price\": 1.12,\n \"Monthly\": false,\n \"Active\": true\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6062d411-e999-489a-a71a-c67603ea435a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e346114e-80cd-40a5-98d5-26e5c9dae2b7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d8c555a-6e9c-4b05-94f2-15704eff00a3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7358b70-39f7-4a17-b6ee-ca4952b67374", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22b32801-0508-4422-a025-ae208e9059b9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50ecc10e-8722-45b2-8b75-cfbaaae90f38", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7e82b26-32e1-458b-b457-5125340fbec1", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12af7826-07c6-458c-ba82-1d64a4859e92", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04bd0e66-c03c-4edb-ac86-d69871516ae3", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03bc883f-b7c3-4d5e-8490-7f8f8fde7af7", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "PackageId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e56c8d3e-cbe4-4f2e-a2e5-eabe2a26f6fc", "name": "Add Package Item", "request": { "name": "Add Package Item", "description": { "content": "Add a product to an existing package. Specify the package, product, price, and billing frequency for the item.\n\n**What this does:** Returns the new package item ID and confirmation. Adding an item to a package makes that product available to all subscribers with an active subscription to this package.\n\n**Next steps:**\n- View all items in the package — `GET /v1.0/packages/items`\n- Remove an item — `POST /v1.0/packages/items/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"\",\n \"ProductId\": \"\",\n \"Price\": \"\",\n \"Monthly\": \"\",\n \"Type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "da4442b0-ece1-4509-8f45-1b4789478919", "name": "Add Package Item", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PackageItemId\": \"PIID-4efee842-16f0-4803-9780-8c3c30d19b74\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"Type 3\",\n \"Price\": 1.12,\n \"Monthly\": false,\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee4872a6-b1a2-468f-b7d2-6274e4a17abb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dcb3c3f-2c49-422b-8a1b-e423af077973", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc2b4e01-4e2e-41d5-87a3-24509a8c12bc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f0fa3b0-6d8d-469e-b2e1-ae677aec9c68", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b15f233d-b3d7-42fb-b02a-ef1789083484", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd298239-67e0-41e7-a922-496574e951be", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c193d50f-ba60-4a0f-bac0-bdc74a457919", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a7295e1-af6f-4c68-a4e5-d18932612179", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9c93d52-de5d-47f1-995a-d89e2a3edaab", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d446c13-6950-493d-9dcf-e713997e5607", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"Type 3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81811a4b-4cef-40b2-87d5-9a037faff5ef", "name": "Update Package Item", "request": { "name": "Update Package Item", "description": { "content": "Update an existing item within a package. Modify price, type, or billing frequency for the package item.\n\n**What this does:** Returns the updated package item record. Use this to adjust pricing or billing frequency for a product within a specific package without affecting the product definition itself.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/packages/items`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"\",\n \"PackageItemId\": \"\",\n \"Price\": \"\",\n \"Monthly\": \"\",\n \"Type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9006ef3c-a5d3-42f2-a774-ad2a2fdba206", "name": "Update Package Item", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PackageItemId\": \"PIID-4efee842-16f0-4803-9780-8c3c30d19b74\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"ProductId\": \"PRID-9E4F3852-5405-E9FC-2FDF-7A0530B7D862\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": \"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"Type\": \"Type 3\",\n \"Price\": 1.12,\n \"Monthly\": false,\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9ab7152-9782-4deb-bd5d-3d896ec6fb8b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f86fa6d5-2664-4f44-8fb8-e06cea9e6270", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccec669d-e96b-4340-bb97-9923dccfbc1c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d45830e2-109d-4588-96b2-b0ec958a6a93", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96e6730a-730a-4028-a59d-e576d5034eb5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66b26f8d-4787-4b53-978e-82b706c9647c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66d10315-dc81-4c24-9604-681ca02bd86e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbb05d45-38b8-4e98-9059-f7e8d8886298", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e607defa-9415-412c-8177-c50bd0fb9a09", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2f74e7a-8543-4909-88f5-f1546e260f22", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"PackageItemId\": \"PIID-a102d17b-09a9-4096-a597-e48c055d8d6d\",\n \"Price\": \"1.12\",\n \"Monthly\": false,\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "872193a8-1a4b-4938-801e-dff634e55a1d", "name": "Delete Package Item", "request": { "name": "Delete Package Item", "description": { "content": "Remove an item from a package. This removes the product association from the package but does not delete the product itself.\n\n**What this does:** Returns a deletion confirmation. Removing an item from a package removes that product from the package's service bundle. Active subscriptions to this package lose access to the product going forward.\n\n**Next steps:**\n- View remaining items — `GET /v1.0/packages/items`", "type": "text/plain" }, "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"\",\n \"PackageItemId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9bfee1eb-2097-421c-9779-e93258f32d06", "name": "Delete Package Item", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\",\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemStatus\": \"Deleted\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a669c52e-4eb6-4f27-9d30-49b0c717dd7f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8b86317-59c5-44f3-bda1-b7158772d76c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c75ea54e-e6e3-4cdc-9646-8b42558b6232", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "247e6d2b-2687-49bb-b9c7-140f8a1115ae", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5a5fd4e-0c75-43ed-aab1-19a5c31ae7d1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "475e2bfc-eff4-4ef3-bebf-06d856d020b3", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cae3610-fea8-4238-8846-947248545a33", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aab10e32-4b54-4199-8e76-7e1b2229e578", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5162ea4a-e8d8-4f8b-a877-02fbb4f89cd7", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b82ba758-b9fe-4980-9860-8a0c6b5a86d6", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "packages", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PackageId\": \"PID-d869bdbf-895e-44fe-986b-1fabce90b994\",\n \"PackageItemId\": \"PIID-eee3dd72-03ce-40f0-a80d-5bcadedda1d9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6a331eff-4564-4e74-a466-d4545250e12d", "name": "Products", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "91ae96c8-201e-42ae-aa57-b4ac4cfa8fab", "name": "Product Details", "request": { "name": "Product Details", "description": { "content": "Retrieve detailed information about a specific product by its ProductId. Returns SKU, description, type, cost, and billing frequency.\n\n**What this does:** Returns the product details including SKU, description, type, cost, and billing frequency. Use this to retrieve the `PRID-` ID needed when adding products to packages.\n\n**Next steps:**\n- Add this product to a package — `POST /v1.0/packages/items/add`\n- Update product — `POST /v1.0/products/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ProductId", "value": "", "description": "The unique product ID to retrieve details for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6d99eb26-65e0-4aa7-a697-0a334d73353f", "name": "Product Details", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ProductId\": \"PRID-4384E69B-3194-9943-F839-20E477C8E399\",\n \"SKU\": \"VAS035\",\n \"Description\": \"Fraud Detection + Blocking\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": null,\n \"Type\": \"VAS\",\n \"SubType\": \"AI Operator\",\n \"Cost\": 1,\n \"BillingFrequency\": \"MRC\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3248466-ec40-4b94-90e8-ab7ccbc0a4fd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be6ebcff-a2c4-496a-bf84-f4ec89a83c8c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ae7e19b-7c60-41a7-822b-0aa9dd2b9ffa", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99111d4d-570b-4314-b9ab-bc434593e90a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46047ede-a990-4945-b48e-9c950d5576a9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc77db50-93cb-4d7a-b519-73b633041e8b", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01f10f3e-8043-4a01-843b-c6ddd0ba017c", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8aa7d53e-89d4-4c04-9416-551582fde2f5", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d319dc57-3e3e-4644-b34f-3ada84c7f856", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb43c2c0-b419-4685-a0b5-b28022a9b422", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ProductId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62fde610-6857-4e4d-9d30-68e7f3ae06a9", "name": "Create Product", "request": { "name": "Create Product", "description": { "content": "Create a new product with SKU, description, type, cost, and billing frequency. Products can be bundled into packages for subscriber offerings.\n\n**What this does:** Returns the new product's `ProductId` (`PRID-`) and full record. Once created, add it to packages using the package items endpoints.\n\n**Next steps:**\n- Add the product to a package — `POST /v1.0/packages/items/add`\n- Create a service — `POST /v1.0/services`", "type": "text/plain" }, "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SKU\": \"\",\n \"Description\": \"\",\n \"Type\": \"\",\n \"Cost\": \"\",\n \"BillingFrequency\": \"\",\n \"SubType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "138c0712-fc48-4b0b-bad9-1ae66246e5b2", "name": "Create Product", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ProductId\": \"PRID-4384E69B-3194-9943-F839-20E477C8E399\",\n \"SKU\": \"VAS035\",\n \"Description\": \"Fraud Detection + Blocking\",\n \"AggregatorId\": \"AGID-1e24785ab-3f3c-7db1-89d7-956d80fdnn2\",\n \"DistributorId\": null,\n \"Type\": \"VAS\",\n \"SubType\": \"AI Operator\",\n \"Cost\": 1,\n \"BillingFrequency\": \"MRC\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f127e27d-c85a-45ba-9e1c-bd4ce19e63df", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f303ac1-5ce0-4a43-9913-9f3259149e8c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30fecee5-61cc-4c99-b608-8e2070272590", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c357dc9a-125c-4b50-a3a5-a2f5a5fe5add", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3172d97-3dbc-44c0-8705-9b3ba4f513a9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdd8adb4-5b58-4738-a638-35b94a0b47d0", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82194c47-25af-41f0-b158-d01cbba3ef58", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "048f1414-178d-4590-9a13-119cb216bdda", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e9da914-b44d-481f-98d3-f9ad6ef79772", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "171e12fa-b58e-484a-acfb-ff576d193f16", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\",\n \"SubType\": \"esim\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b6fddc0-21da-414d-ac65-9292f287d987", "name": "Update Product", "request": { "name": "Update Product", "description": { "content": "Update an existing product's SKU, description, type, cost, or billing cycle. Changes apply immediately and are reflected across all packages that include this product. Use the ProductId (PID-) returned when the product was created.\n\n**What this does:** Returns the updated product record. Only fields you send are changed. Changes affect all packages that include this product at their next billing cycle.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/products`", "type": "text/plain" }, "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\",\n \"SKU\": \"\",\n \"Description\": \"\",\n \"Type\": \"\",\n \"SubType\": \"\",\n \"Cost\": \"\",\n \"BillingFrequency\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "70bdfd62-676d-4a65-894c-fe058bf2c359", "name": "Update Product", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4773d8ea-051e-4d30-b836-1ad6b2ac1164", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9a73e25-360d-439a-ad13-f161ab14fad2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02defaa2-14fe-4d07-b129-a8c6871dd3a6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "154703f4-7123-4607-b588-ba77eb975a40", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b44e2154-7850-42ee-8538-6f89653c038b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9c7c520-e932-4376-bb86-d0d3079c8556", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "248317e0-f4b0-456f-96b9-01b2a4f57ab1", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9beef2fb-7a06-48e9-9fe8-3ecf4cfa9003", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "057f1ee4-e2d0-418c-9f63-39ba3daded15", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c3b8178-911f-41b4-b886-a7af437a4df8", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "products", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415\",\n \"SKU\": \"eSim\",\n \"Description\": \"Telegent eSim\",\n \"Type\": \"esim\",\n \"SubType\": \"esim\",\n \"Cost\": 12.34,\n \"BillingFrequency\": \"MRC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1520731c-60bf-468d-b46e-3cf4ce05cfef", "name": "Delete Product", "request": { "name": "Delete Product", "description": { "content": "Permanently delete a product by its ProductId. This action cannot be undone.\n\n**What this does:** Returns a deletion confirmation. Products included in active packages cannot be deleted — remove them from all packages first.\n\n**Next steps:**\n- Remove from a package — `POST /v1.0/packages/items/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "13bda290-dd81-41e4-b05c-f88348c45aeb", "name": "Delete Product", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\",\n \"ProductStatus\": \"Deleted\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "368bec10-1e4f-490e-b92d-94c3c08b3e48", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d83fd72-0d04-4cc2-af7a-07cf6727c5cb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13aca8e5-19bc-4c80-b208-5db06e835530", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b109e7f1-b39f-4aa4-be6f-e3d5f181e826", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26cd6af5-e48d-4a88-9f4c-8085eb7ff3a6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b92689a9-9f06-4e7c-ba70-53802d0d8af9", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc9fade2-f739-480d-9a55-c36ba1ba4c64", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a72047bb-54af-42e7-b786-86dd0182728d", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f00c7d-f3f2-4a02-acd6-10e9f735de60", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "957938ce-b260-486b-81a2-bf93581020c4", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "products", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"PRID-d9e74d70-3ca8-40f3-a415-e1194b0f8936\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c3f9790a-65ec-44b1-9281-3843dd408603", "name": "Schedules", "description": { "content": "", "type": "text/plain" }, "item": [], "event": [] }, { "id": "0c97fa1a-ee71-4908-a3fa-ae12df2b5690", "name": "Services", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "89055569-e78a-4eba-9b73-19750481e2e3", "name": "Get Service Details", "request": { "name": "Get Service Details", "description": { "content": "Retrieve detailed information about a specific service by its ServiceId. Returns service name, cost, billing frequency, and status.\n\n**What this does:** Returns the service details including name, cost, billing frequency, and status. Use this to retrieve the `SID-` ID needed when adding service items or associating the service with products.\n\n**Next steps:**\n- View service items — `GET /v1.0/services/items`\n- Update service — `POST /v1.0/services/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ServiceId", "value": "", "description": "The unique service ID to retrieve details for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b0e1cb52-bf2a-4782-b6de-fe7685178bf4", "name": "Service-Details", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true,\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "087199da-b9b4-4f18-b00c-7ce178fcb6b1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d2a511-bc7e-44fe-91db-dbd7825f5ba5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "155489dc-d676-4d0c-ab26-4bb9fb4417ef", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5708435-6780-44b3-bc9a-53325564f5fd", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3c72ae9-f47d-4bab-8fa6-192e0a49a96f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f49be8f-4068-4db2-92dd-5e60c212dd76", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f410935d-35b5-4c14-ad63-c47037940c1f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f5f48e4-47b3-42db-b4ec-b7cad904e924", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b9fd95-34b5-4628-a751-8b2b6a5a4187", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bb6b4a5-9b9e-41f0-b4aa-6c5313732f95", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1ef6409-f117-46ba-9700-12157f0643b4", "name": "Create Service", "request": { "name": "Create Service", "description": { "content": "Create a new service with a name, cost, and billing frequency. Services can be added to packages and assigned to subscribers.\n\n**What this does:** Returns the new service's `ServiceId` (`SID-`) and full record. Services are the billable unit; add pricing tiers using the service items endpoints, then associate the service with products.\n\n**Next steps:**\n- Add a pricing item — `POST /v1.0/services/items/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"\",\n \"Cost\": \"\",\n \"Monthly\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cc285b51-f1b6-4c93-bb58-ec1c18d17aea", "name": "Create Service", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true,\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef004727-3638-475c-bd00-9ee1f9cf5339", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e90aef-bc11-4695-b520-0ac2327d6da7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eba48d63-5edf-4879-97c8-a064ebce871d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c825fe8-e88c-4ebf-bd56-00fcb686f3d8", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78691e68-27c5-4df1-a50f-623f16205aa7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a80fc13-11ba-4d26-8262-340278b9906a", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37b89dac-0ec0-4d70-a40a-2af536f233d5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4a3c28-618c-4aaa-a147-b113133187c9", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "874e5b5c-0d2a-47b7-a00f-f87668b9b92d", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c79348d-3454-4498-90a4-2acfe0797b89", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 1.23,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e85aaeb2-0c9d-46ce-b763-e5cd26766ed2", "name": "Update Service", "request": { "name": "Update Service", "description": { "content": "Update an existing service's name, cost, or billing cycle. Changes take effect immediately and are reflected across all packages and subscriptions that include this service. Use the ServiceId returned when the service was created.\n\n**What this does:** Returns the updated service record. Only fields you send are changed; omitted fields retain their current values.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/services`\n- View service items — `GET /v1.0/services/items`", "type": "text/plain" }, "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"\",\n \"ServiceName\": \"\",\n \"Cost\": \"\",\n \"Monthly\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3e333d25-6736-4437-a18c-ecf0642d2970", "name": "Update Service", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d1a71db-44ed-4b81-9977-15d86f498ba5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caf4a915-c968-451e-bdb5-14e0b000d0e2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60c0086e-5d1b-4864-a482-35bf5e8ddb07", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f74f2ced-beeb-40f7-bd46-fdd1ebf832f7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aca1597-a1cc-46ca-9f3f-f754c4a930cb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca8bf2d1-5742-4b11-b952-8c4616addfde", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f389e68f-4a9d-47ff-811d-3c40770fbe4e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "315b0b24-aa0e-4c70-b6b2-3e7d5543d2ed", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e5ca8ac-6744-4bdd-a1d0-ffbb03169ca0", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3199d7d3-8018-4f44-9965-1716cdbd1543", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\",\n \"ServiceName\": \"Caller Id\",\n \"Cost\": 2.34,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c196d014-70ea-4823-9c86-52b8ad057ff3", "name": "Delete Service", "request": { "name": "Delete Service", "description": { "content": "Permanently delete a service by its ServiceId. This action cannot be undone.\n\n**What this does:** Returns a deletion confirmation. Deleting a service removes it from the platform permanently — ensure it is not referenced in any active products or packages before deleting.\n\n**Next steps:**\n- View all services — `GET /v1.0/services`", "type": "text/plain" }, "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d408a58d-64a7-4219-9ba5-2ff6581404da", "name": "Update Service", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7212066-a652-4fae-92a4-b8282b14bb14", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d00d279-902f-4cea-b999-9c412f100941", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78acebb9-35cb-4f1a-87a3-e20017cbea59", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20c7773f-de89-49eb-a7cd-a2eef7fad2a9", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f937ab37-e554-4530-ae02-6e5e8cd093ab", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5224a61-8505-42b2-9fc9-1f0b2e371c9c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b7ba933-0515-4b58-938c-94b517f02d2e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cfd2b16-d207-480f-9d95-7065f433c758", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d8d85d-c2e2-44c1-bd4e-e45dc7f65c10", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de8df84c-6928-422c-9a19-e027d56a35e7", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-65d007be-8b49-45ac-b8ae-77b8d6a66c8b\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43353b19-e738-4a23-aabd-f3734f473548", "name": "Get Service Items", "request": { "name": "Get Service Items", "description": { "content": "Retrieve the items (pricing tiers or components) associated with a specific service. Pass the ServiceId to get its configured items.\n\n**What this does:** Returns the list of pricing items for the service including price, billing frequency (monthly or one-time), and distributor/aggregator scope. Use this to audit or review the pricing tiers before modifying them.\n\n**Next steps:**\n- Add a pricing item — `POST /v1.0/services/items/add`\n- Update an item — `POST /v1.0/services/items/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ServiceId", "value": "", "description": "The service ID to retrieve items for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9837a186-d666-4db7-a6c7-518c6d8224a1", "name": "Success — returns the service items for the specified service", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ServiceId\": \"SID-abc123\",\n \"Items\": [\n {\n \"Price\": 9.99,\n \"Monthly\": true,\n \"Active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd83d175-2b5d-42a3-b206-974dc932a944", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "139a645a-ea83-43b4-803e-f0dc733c8bf5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "685ff07a-a6be-462e-a015-899f140b3f94", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4ba1bdf-222e-4931-90a1-068353f7b9ca", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b608cd4-178a-44f3-969f-c16e1a7713f8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dde38ea6-ee0a-4196-8c4d-7249cd53ceb6", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ffd36b7-23fc-4be4-a261-b1f1abf0aa64", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7486074-d95f-4c41-8b5d-7b91c6c5913b", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07b19014-587a-4b43-90a5-01d69656aad6", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd0b1d65-b0f1-448c-bfdb-c889b26e450a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ServiceId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ffa59cc0-24b5-4150-9148-034dc2bbdcef", "name": "Add Service Item", "request": { "name": "Add Service Item", "description": { "content": "Add a new pricing item or component to an existing service. Service items define the cost and billing frequency (monthly or one-time) for the service at a specific distributor or aggregator level.\n\n**What this does:** Returns a confirmation for the new item. Service items define the price and billing frequency for a service at a specific distributor or aggregator scope. Multiple items can exist on a single service for different pricing tiers.\n\n**Next steps:**\n- View all items on the service — `GET /v1.0/services/items`\n- Update an item — `POST /v1.0/services/items/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"\",\n \"AggregatorId\": \"\",\n \"DistributorId\": \"\",\n \"Price\": \"\",\n \"Monthly\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a29988a4-6776-4e83-891b-fd4886e40039", "name": "Success — returns the created service item", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ServiceId\": \"SID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true,\n \"Successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425b7d59-e9e3-47b6-9040-5b1838b1ebe5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "522609d7-4ff0-4e10-9bcb-30f874bbd510", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad51f583-5632-4af7-9c82-b02a19b408e2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7c4c0e9-8f13-4ab3-a96d-6a19faf1b4ee", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d28a4ce-dc2c-4ced-92d5-28895ca408d0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81778dbf-8201-487a-8ef9-dedc75d10a03", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "515874e1-b83b-4e3e-b59b-8105eb1db609", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8267b8e-c8bb-48d3-b7cf-7aaf775ca083", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "101b639c-b0f5-4c18-b50b-8034e196b2df", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dd84f57-8a0e-4f38-b221-6204fcf3ebbb", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 9.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75a62029-527f-4a06-ad28-e2481798930b", "name": "Update Service Item", "request": { "name": "Update Service Item", "description": { "content": "Update an existing service item's pricing or billing configuration.\n\n**What this does:** Returns the updated service item record. Only the fields you send are changed. Pricing changes apply at the next billing cycle for active subscriptions using this service.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/services/items`", "type": "text/plain" }, "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"\",\n \"AggregatorId\": \"\",\n \"DistributorId\": \"\",\n \"Price\": \"\",\n \"Monthly\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e54ba403-b5a3-4f00-86d6-115aa16ce569", "name": "Success — returns the updated service item", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Price\": 14.99,\n \"Monthly\": true,\n \"Successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de47b0e2-6188-4f24-b540-b714418b7c22", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0af19a0-1502-444b-8c79-d3997d7f0f89", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0365f3df-49aa-49cc-9943-889a1b7f6b1e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81668b8f-5da4-4477-83af-d5ad6476395b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aa42476-632f-4bc8-a9ca-bdbe6b3035b6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de70b7e2-e6ea-4ae4-9b0f-ebbd1727c7aa", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7efec6f1-eaa6-4fd7-aeb8-30bcfd54056a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e32fd9a1-1871-4703-b175-06ff005d2a07", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaece485-e285-4ac1-b083-c28f98ba07d9", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "844ba91d-55b4-466e-8b3e-11209d32e173", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\",\n \"AggregatorId\": \"AGG-abc123\",\n \"DistributorId\": \"DID-abc123\",\n \"Price\": 14.99,\n \"Monthly\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfc1d8be-88cc-41a4-83ca-a7829a7f474d", "name": "Delete Service Item", "request": { "name": "Delete Service Item", "description": { "content": "Remove a service item from a service.\n\n**What this does:** Returns a deletion confirmation. Removes the pricing tier from the service. Ensure no active subscriptions depend on this item before deleting.\n\n**Next steps:**\n- View remaining items — `GET /v1.0/services/items`", "type": "text/plain" }, "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2cf6ab9a-73f7-4834-a948-ad204a8f40b3", "name": "Success — returns deletion confirmation", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2f9a72d-bab9-4191-a072-352baea5b2f2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e528ba78-32ce-427b-98bd-35d3759918ac", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "136e24b6-b4bd-42fe-bcf0-72befe1aebbd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c665156-cf3c-4fc9-b015-a26eea50ebd4", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c88d591e-27b8-42d3-b365-4489607f56ea", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf86bf07-1038-4e49-99be-ebc904e0f947", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0daaa88-aba8-4dd4-ab8c-22b03126f77c", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81667b8e-d3f9-4aef-8a2b-bd75c2e584f9", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d291056-a5ff-4c2c-b119-055128257154", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b12504a-7a1e-4394-8229-bb4c428d27ef", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "services", "items", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServiceId\": \"SID-abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "61e31ae8-3822-4651-a855-7426cdc7911f", "name": "Sims", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "59bc43ef-7448-4307-8aab-12ddb3be10ff", "name": "Update SIM Status", "request": { "name": "Update SIM Status", "description": { "content": "Update the status of a SIM card using its ICCID. Use this to activate, suspend, or change the state of a physical or eSIM card in the network.\n\n**What this does:** Returns the updated SIM `SimStatus` and a success confirmation. Valid statuses are `Active`, `Suspended`, and `Empty`. Use `Active` to enable the SIM, `Suspended` to temporarily disable it while retaining the number association, or `Empty` to clear all associations.\n\n**Next steps:**\n- Confirm the change — `GET /v1.0/numbers`\n- Clear all SIM associations — `POST /v1.0/sims/clear-status`", "type": "text/plain" }, "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"\",\n \"MSISDN\": \"\",\n \"SimStatus\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8aee204e-5779-436c-a22f-fefc7967af5c", "name": "Success — returns the updated SIM status", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ICCID\": \"8901240397190195850\",\n \"SimStatus\": \"Active\",\n \"Successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06dadfea-9b49-4747-bdd0-2ab5c8ce512b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c170af88-87e5-48a9-8712-92819196d72a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdb8a6e3-22bf-47c2-b927-75e923d47de7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf601127-06bd-43ac-b80e-2b58be95bdd2", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26fcc271-16e3-423b-af0d-04a4fc62d9a0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cd312c5-7db4-45bd-9a7c-6a073165c8ea", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387fe7f3-9da2-48d3-88a9-cd45d8b13f27", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42f0bbb3-21cf-4db8-befc-1619d9d1d2f9", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df2a0cb8-3969-4244-8e2a-007e76c22b95", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f58c03a-3f92-4a3b-ba60-3b03af13c65e", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "sims", "update-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\",\n \"MSISDN\": \"+11234567890\",\n \"SimStatus\": \"Active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89a7377c-d85a-49c4-822e-0e3208312732", "name": "Clear SIM Status", "request": { "name": "Clear SIM Status", "description": { "content": "Reset a SIM card's status to Empty, effectively unassigning it from any active number or subscriber. Useful when decommissioning a SIM before reassigning it.\n\n**What this does:** Returns the ICCID with a status of `Empty` and a success confirmation. After clearing, the SIM is unassigned and ready to be re-provisioned or reassigned to a different number.\n\n**Next steps:**\n- Re-provision the SIM — `POST /v1.0/numbers/provision`\n- Assign a new status — `POST /v1.0/sims/update-status`", "type": "text/plain" }, "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0d000a89-293d-470f-85e0-581e8cb13f56", "name": "Success — returns the SIM with Empty status", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ICCID\": \"8901240397190195850\",\n \"SimStatus\": \"Empty\",\n \"Successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21010859-2c56-45aa-b7f0-78a85f371c3c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb6388b-16a8-44fa-b36f-793a0fc8f866", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b735e138-8886-4771-b2ae-0f459e6a1836", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f558b0-d78d-4ff3-9748-d5d5b17e37d7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9cd311e-4733-460a-aca7-ed08f4028535", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c217c62-f0cb-4043-aa66-2e4c8f1b92f9", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab9226d5-4cf8-4990-a8be-0949f5a27e50", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0b502db-46ff-4c0e-94c0-2f5b722774d9", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9f4fc59-3dda-4b0a-888e-2aeb08411f93", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9e322b8-3f29-4df3-abdd-7d5ff088aada", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "sims", "clear-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ICCID\": \"8901240397190195850\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "46b2e6c3-5bf2-4dc0-8579-ade0d594e7fc", "name": "Subscribers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d3bb7676-23ff-4019-97cf-91a18506923c", "name": "Get Subscriber Details", "request": { "name": "Get Subscriber Details", "description": { "content": "Retrieve detailed information about a specific subscriber including name, email, phone numbers, role, and associated account details.\n\n**What this does:** Returns the subscriber's profile including name, email, role, assigned phone numbers, account ID, and status. Use this to confirm a subscriber's configuration or retrieve the `TSUID-` for use in subscription and AI Guardian calls.\n\n**Next steps:**\n- Update subscriber — `POST /v1.0/subscribers/update`\n- Assign a subscription — `POST /v1.0/subscriptions`\n- Enable AI Guardian — `POST /v1.0/subscribers/guardian-features`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "(Required) Subscriber ID to retrieve details for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "237872b8-4885-48a8-8043-9c90301789c7", "name": "Subscriber Details Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriberId\": \"TSUID-03F91441-B652-4EBE-B310-24652F872584\",\n \"Name\": \"Bennet Hill\",\n \"Email\": \"bennet@joonto.com\",\n \"PhoneNumbers\": [\n \"+13854613193\"\n ],\n \"Role\": \"Subscriber\",\n \"Account\": {\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"CompanyName\": \"Telegent Account\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b90fc2c2-0a29-4d03-864b-7fef6430188f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fe740df-8b6f-4908-8ecc-2fd60b50b94b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e0e7369-d99d-4d05-8411-65b18eacb731", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4f8610a-93d7-4178-ba26-cf4b16cd8228", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5936935a-1f91-4272-9241-e05bc1489085", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b08307c9-34da-4b1f-a934-6ceb488a625c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5973780e-9972-4f2f-89f0-2a83d9f6a08e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b3dfe33-97cd-4a48-bda9-cb69950c776c", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66487df0-339c-4ad6-88c8-a9882162be23", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c98f748f-9362-4a9b-8fa3-9ff693757807", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81e4ad71-57ec-45a4-8914-fc863aa87beb", "name": "Create Subscriber", "request": { "name": "Create Subscriber", "description": { "content": "**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Required:** Account ID (AID) — provided by your Telegent representative\n\n---\n\nCreate a new subscriber with name, email, phone numbers, role, and password. Returns the newly created subscriber details.\n\n**What this does:** Returns the new subscriber's `SubscriberId` (`TSUID-`) and full profile. The `TSUID-` is required for creating subscriptions, assigning numbers, and configuring AI Guardian. Store it for all subsequent subscriber-related calls.\n\n**Next steps:**\n- Assign a subscription — `POST /v1.0/subscriptions`\n- Provision a number — `POST /v1.0/numbers/provision`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Name\": \"\",\n \"Email\": \"\",\n \"PhoneNumbers\": [\n \"\",\n \"\"\n ],\n \"Role\": \"\",\n \"Password\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "307814fe-7774-4925-9800-30b06c4136f3", "name": "Success — returns the new Subscriber ID (TSUID-) and account details", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriberId\": \"TSUID-90c644ff-7f70-4587-a27e-d1d45bde7528\",\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Account\": {\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"CompanyName\": \"Telegent Account\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f0a648-cc36-467f-b49a-c7a465b11ce8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75dd3045-7c98-4521-b67f-b32e23a12d49", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a36151d1-a58b-47e4-ae89-07aa51f57ab1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7fb128e-b118-4170-ac97-034b029a8b99", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "908b28bc-0a46-499c-a889-7d36ec3de949", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6112a70e-b1bf-4fa8-9557-03b47d33cba1", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2705fcdf-118d-4c04-bc57-856cc78c26c1", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a11983c-61c5-405e-af53-cdfee3cee1b7", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f89b1a95-8e22-47d0-bf81-2501c2b79b11", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bd935b4-7d13-43aa-a4bb-c6e07e230208", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"Jerome User 4\",\n \"Email\": \"jerome4@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"1234567890\",\n \"AccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83aab36b-00db-4347-982b-3d006cc62715", "name": "Update Subscriber", "request": { "name": "Update Subscriber", "description": { "content": "Update an existing subscriber's information including name, phone numbers, role, and password.\n\n**What this does:** Returns the updated subscriber record. Only the fields you send are changed; omitted fields retain their current values.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/subscribers/get`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"Name\": \"\",\n \"PhoneNumbers\": [\n \"\",\n \"\"\n ],\n \"Role\": \"\",\n \"Password\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0342e54d-5a60-45f9-a0d3-410c15d1f92a", "name": "Subscriber Updated", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"Email\": \"jerome3@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Account\": {\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"CompanyName\": \"Telegent Account\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "627913c9-8504-4062-be6e-5fe819cdb1f7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb2e0eec-b97d-42b6-ac73-fad51cd1a1ab", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d75ef9f4-86fd-4e56-950a-73f46c8e29fd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9399c478-8b85-40f5-b004-f8e7e4796fba", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3224caa-bc08-4c0a-a520-41174699fb9e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dbe5073-3dac-4e9c-bed8-141d75be5df9", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac34ff49-6ba3-4502-bbc4-bafd8b58d03b", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4012847f-267e-4a97-b701-6b197a778eb5", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "429b0a5e-c44c-44f4-8236-faac0c208540", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30945d5c-0264-4c4d-b480-28e94a308952", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Password\": \"bUxdo6-zewqez\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d156d6b-0ce0-4622-aad7-655d5a6b35ab", "name": "Transfer Subscriber", "request": { "name": "Transfer Subscriber", "description": { "content": "Transfer a subscriber from one account to another. Requires both origin and destination account IDs.\n\n**What this does:** Returns a confirmation that the subscriber has been moved to the target account. All subscriptions and number assignments are preserved. Use this in reseller workflows when a subscriber needs to move between managed accounts.\n\n**Next steps:**\n- Confirm new account association — `GET /v1.0/subscribers/get`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"FromAccountId\": \"\",\n \"ToAccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d31da66d-338d-4f5c-a16c-4a31ff41347f", "name": "Subscriber Transferred", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"Name\": \"Jerome User 3.1\",\n \"Email\": \"jerome3@joonto.com\",\n \"PhoneNumbers\": [\n \"+1234567890\"\n ],\n \"Role\": \"Subscriber\",\n \"Account\": {\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"CompanyName\": \"Telegent Account\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a5a0e26-b945-4e09-b62e-ebd16f232f2b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f4263b4-8acd-4a30-8dc0-d12c00891b7c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83181325-72b7-4093-8ac5-27755f44ff73", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cd0f930-e296-4a01-a20f-5c5e3737ef57", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fabacab-0017-4c1c-8fbb-b0f919fcbf54", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0796be0-2c07-451f-a2f1-e1e018461d8e", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d58f1c63-76bb-420f-8bc8-fc5632015750", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "490b41bd-e8d6-4f86-808a-6452295a94fa", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2ef731c-64cf-4af0-b23e-3200e07951f5", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dfcf6db-1420-41de-bd79-53cf27c6ba9a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-33bde952-f6ec-4171-ad11-9697cfed79e8\",\n \"FromAccountId\": \"AID-eab92510-1040-45a5-bb9c-0bad9272f89d\",\n \"ToAccountId\": \"AID-ceb82085-2725-45a1-bd5e-526ed19799d7\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f14a0f50-fc21-4aac-afc1-fcdebda68b79", "name": "Create Message Filter", "request": { "name": "Create Message Filter", "description": { "content": "Create a new message filter that controls what messages a subscriber can send and receive.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing Subscriber (`TSUID-`) — `POST /v1.0/subscribers/create`\n- AI Guardian enabled for messages — `POST /v1.0/subscribers/guardian-features`\n\n**What this does:** Creates a filter and returns a `MessageFilterId` (`MFID-`). The filter applies to the specified phone number. Configure mode (`ACTIVE`/`MONITOR_ONLY`/`INACTIVE`), allowed/blocked contacts, keyword rules, and restrictions on links, media, and unknown numbers. The filter takes effect immediately.\n\n**Next steps:**\n- Verify it was saved — `GET /v1.0/subscribers/message-filter`\n- Add trusted contacts that bypass filtering — `POST /v1.0/subscribers/message-filter/allowed-contacts/add`\n- Add senders to silently drop — `POST /v1.0/subscribers/message-filter/blocked-contacts/add`\n- Review configured keywords — `GET /v1.0/subscribers/message-filter/keywords`\n- Update later — `POST /v1.0/subscribers/message-filter/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e3d6f104-5095-4dc0-ab6b-9f5ad1fbdf1c", "name": "Message Filter Created", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"+1111111111\",\n \"+2222222222\"\n ],\n \"BlockedContacts\": [\n \"+3333333333\"\n ],\n \"KeywordFilter\": \"\\\"CustomKeywords\\\":[\\\"inappropriate\\\",\\\"banned\\\"],\\\"SystemKeywords\\\":{\\\"Profanity\\\":[\\\"word1\\\",\\\"word2\\\"],\\\"Violence\\\":[\\\"threat1\\\"]},\\\"SeverityMap\\\":{\\\"Word1\\\":\\\"HIGH\\\",\\\"Inappropriate\\\":\\\"MEDIUM\\\"}\",\n \"NotificationPhones\": [\n \"+9999999999\"\n ],\n \"ApplyToOutbound\": true,\n \"ApplyToInbound\": true,\n \"BlockUnknownNumbers\": true,\n \"BlockLinks\": true,\n \"BlockMedia\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e159621d-b67e-4362-b2a2-ca501175bed5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3678f771-e26e-47a9-9f76-86633352ef00", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "250717d5-8616-4bf3-b47c-0e422fc52e6f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fc3406c-37ea-4a92-be7d-303653499dc5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c130920-81f8-455e-b52f-9223a27db4fd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faf6bb25-e495-4b66-b4ae-526c498a485a", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0978cdc-9250-4566-85e2-c14db2619be6", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a6ac335-8d5b-482a-8aac-73e1fdca7771", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeaced82-fec1-4dd1-9595-175c86e8a437", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c56183e-4236-45de-9de2-56d5e89fb12f", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7e9db27-2f62-4387-88a4-5cf3af3ef7b4", "name": "Get Message Filters", "request": { "name": "Get Message Filters", "description": { "content": "List the message filters configured on a subscriber or phone number.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID or phone number to filter by (otherwise returns all)\n\n**What this does:** Returns the full configuration of each matching filter — mode, allowed/blocked contacts, keyword rules, and restrictions on links/media/unknown numbers. Use this to audit a subscriber's messaging controls or to find the `MessageFilterId` (`MFID-`) you need for subsequent calls.\n\n**Next steps:**\n- Inspect allowed/blocked lists in detail — `GET /v1.0/subscribers/message-filter/allowed-contacts`, `GET /v1.0/subscribers/message-filter/blocked-contacts`\n- View keyword rules — `GET /v1.0/subscribers/message-filter/keywords`\n- Modify a filter — `POST /v1.0/subscribers/message-filter/update`\n- Remove a filter — `POST /v1.0/subscribers/message-filter/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "Optional. Return only filters belonging to this subscriber. Format: `TSUID-` followed by a UUID." }, { "disabled": false, "key": "Phone", "value": "", "description": "Optional. Return only filters tied to this phone number. Use E.164 format (e.g., `+15555555555`)." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5dd06ee6-abae-416f-8243-d9ae01546412", "name": "Message Filters Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"FilterId\": \"MFID-6b6766eb-08fe-4680-99b7-731bd0629331\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"ACTIVE\",\n \"AllowedContacts\": [\n \"+1111111111\",\n \"+2222222222\"\n ],\n \"BlockedContacts\": [\n \"+3333333333\"\n ],\n \"KeywordFilter\": \"\\\"CustomKeywords\\\":[\\\"inappropriate\\\",\\\"banned\\\"],\\\"SystemKeywords\\\":{\\\"Profanity\\\":[\\\"word1\\\",\\\"word2\\\"],\\\"Violence\\\":[\\\"threat1\\\"]},\\\"SeverityMap\\\":{\\\"Word1\\\":\\\"HIGH\\\",\\\"Inappropriate\\\":\\\"MEDIUM\\\"}\",\n \"NotificationPhones\": [\n \"+9999999999\"\n ],\n \"ApplyToOutbound\": true,\n \"ApplyToInbound\": true,\n \"BlockUnknownNumbers\": true,\n \"BlockLinks\": true,\n \"BlockMedia\": true\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3fdd4ab-eb27-49df-bde8-f099d51e7720", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c98a18c-1093-4e38-ad6b-90dba9946cc7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d452415-cddf-4d8c-97f2-88a0bc5a3ce8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcac0ec1-6e05-4dd2-bf34-ba6df9f9211f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4763c329-f9e1-47ec-a5a3-b54530451021", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "929c38c3-1142-4df6-8326-49c82cf60c04", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d16a8544-6092-4b67-9cd8-48c22955f90e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7550607-4db0-4d2b-a130-92823019faca", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85e5df61-bf67-4f9a-809a-a5eeb202b89f", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e2d42c5-7c33-49d9-9bcc-1a9d98fef9bd", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2abe125b-bc00-41df-9df6-50476d9017d1", "name": "Update Message Filter", "request": { "name": "Update Message Filter", "description": { "content": "Modify an existing message filter without deleting and recreating it.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing `MessageFilterId` (`MFID-`) — find one with `GET /v1.0/subscribers/message-filter`\n\n**What this does:** Replaces the configuration of the specified filter. Use this to switch modes (e.g., `MONITOR_ONLY` → `ACTIVE` to start enforcing rules), update contact lists, adjust keyword settings, or toggle link/media/unknown-number restrictions. Changes take effect immediately.\n\n**Next steps:**\n- Verify the change — `GET /v1.0/subscribers/message-filter`\n- Pause without deleting — set `FilterMode` to `INACTIVE` and call this endpoint again\n- Permanently remove — `POST /v1.0/subscribers/message-filter/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6f8b782a-231c-49bb-9052-b68e42bf72d7", "name": "Message Filter Updated", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"SID-A1AB23C0-....-....-....-EBE284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"MONITOR_ONLY\",\n \"AllowedContacts\": [\n \"+1111111111\",\n \"+2222222222\"\n ],\n \"BlockedContacts\": [\n \"+3333333333\"\n ],\n \"KeywordFilter\": \"\\\"CustomKeywords\\\":[\\\"inappropriate\\\",\\\"banned\\\"],\\\"SystemKeywords\\\":{\\\"Profanity\\\":[\\\"word1\\\",\\\"word2\\\"],\\\"Violence\\\":[\\\"threat1\\\"]},\\\"SeverityMap\\\":{\\\"Word1\\\":\\\"HIGH\\\",\\\"Inappropriate\\\":\\\"MEDIUM\\\"}\",\n \"NotificationPhones\": [\n \"+9999999999\"\n ],\n \"ApplyToOutbound\": true,\n \"ApplyToInbound\": true,\n \"BlockUnknownNumbers\": true,\n \"BlockLinks\": true,\n \"BlockMedia\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76ee77ba-30e2-42df-8316-f4b8ef0b1fc9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b44c9a38-55d1-4bdd-96b1-8e4ad160a87b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f871c6f-88a5-461e-b678-d7a6a21a2b3d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de84deca-bd1e-4b58-af77-4a06d3ed908c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43f28383-3d46-427f-b356-83714aaac296", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c454e6be-a423-4dce-9eea-964c10759b81", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9f663d6-e68c-453e-8113-b922bf0535b2", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d79ecdf-33b3-4eef-9b4d-65b8b4db85b1", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b3b0fd9-b5cb-4ea5-8a38-241a0ee10e30", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa8ec347-1572-4ba0-9525-5d9b24bbd265", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedContacts\": [\n \"\",\n \"\"\n ],\n \"BlockedContacts\": [\n \"\",\n \"\"\n ],\n \"KeywordFilter\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockLinks\": \"\",\n \"BlockMedia\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7db6281-0949-4526-870f-ca0c16ae08ed", "name": "Delete Message Filter", "request": { "name": "Delete Message Filter", "description": { "content": "Permanently remove a message filter from a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing `MessageFilterId` (`MFID-`)\n\n**What this does:** Permanently deletes the filter and all its associated contacts and keyword rules. Messages will be delivered without any filtering after this call. **This cannot be undone.**\n\n**Tip:** If you only want to pause filtering without losing your settings, use `POST /v1.0/subscribers/message-filter/update` and set `FilterMode` to `INACTIVE` instead.\n\n**Next steps:**\n- Confirm removal — `GET /v1.0/subscribers/message-filter`\n- Create a new filter — `POST /v1.0/subscribers/message-filter`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1ab2f5f3-b5ba-4962-a41b-d01188462fdb", "name": "Message Filter Deleted", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Status\": \"Deleted\",\n \"FilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\",\n \"DateDeleted\": \"2025-11-07T19:27:08.8002065+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "547f0563-b18e-40c7-9aaa-43c28130c656", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43e97a0e-c20b-48a0-a789-b3d20a7276eb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c75de68-f464-4f59-ae4d-86f13c3f9dbb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ba175c0-020e-4f05-a7c4-26ebe616f991", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89f9cd23-bebe-419b-a806-cda582f827ca", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f54c8da6-3907-4936-8567-ea9611d9f8f7", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35b83c93-ea0a-4ce9-b635-9067c8327d1b", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2102d85-6698-4476-aa4b-def74d6a9100", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f38a280-c3bb-4a3e-9f18-34972bc4a177", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29f49191-6a87-42db-9e3a-5682793e3e74", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageFilterId\": \"MFID-e06a2c10-eeb4-4ca7-b3ef-2254b9a79e25\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6fb4044-a2fd-4060-9eb9-577198b8c3a5", "name": "Get Allowed Contacts", "request": { "name": "Get Allowed Contacts", "description": { "content": "View the list of phone numbers that bypass content filtering on a message filter.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `MessageFilterId` (`MFID-`) — find one with `GET /v1.0/subscribers/message-filter`\n\n**What this does:** Returns every phone number on the allowed list. Messages from these contacts skip keyword checks, link blocking, and media restrictions — they are always delivered.\n\n**Next steps:**\n- Add a new trusted contact — `POST /v1.0/subscribers/message-filter/allowed-contacts/add`\n- Remove someone from the list — `POST /v1.0/subscribers/message-filter/allowed-contacts/remove`\n- View the blocked side — `GET /v1.0/subscribers/message-filter/blocked-contacts`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "(Required) Telegent Subscriber ID. Format: `TSUID-` followed by a UUID. Create one via `POST /v1.0/subscribers/create` or look up existing IDs with `GET /v1.0/subscribers/get`." }, { "disabled": false, "key": "MessageFilterId", "value": "", "description": "(Required) Message Filter ID. Format: `MFID-` followed by a UUID. Returned by `POST /v1.0/subscribers/message-filter` (Create) or `GET /v1.0/subscribers/message-filter` (List)." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bc33fc93-3c67-4bc0-a146-e339b8649f1a", "name": "List of Allowed Contacts", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"+1111111111\",\n \"+2222222222\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7cdb0b7-bce1-49f4-8454-528c644756af", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf4dcf09-e9cc-48ef-8d59-84bc67a63b83", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2028103e-a144-420c-99b6-6dbbdc736de6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2da930b-01ed-4108-b9cf-5a8b81c9e5ad", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b3f98f0-53fa-4942-88f6-37035d69ddda", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b24761f-3655-40fb-80a2-ee3672f9f49c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8e5d880-07a5-4904-b1f9-691090e5923a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87ac09a8-525e-45a4-9c65-0af112829978", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4fb5601-c736-4cb2-8354-c173469eaa2e", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7190a1e7-c3e0-41e8-a12c-84fa4ef4933a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8807b43-0d1e-44fd-bea5-3a3e643042c3", "name": "Add Allowed Contacts", "request": { "name": "Add Allowed Contacts", "description": { "content": "Add trusted phone numbers that bypass message filtering.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and an existing `MessageFilterId` (`MFID-`)\n\n**What this does:** Adds one or more phone numbers (E.164 format) to the allowed list. Messages from these contacts bypass all content filtering — keyword checks, link blocking, and media restrictions do not apply. Common use case: family members, doctors, or known business numbers.\n\n**Next steps:**\n- Verify the addition — `GET /v1.0/subscribers/message-filter/allowed-contacts`\n- Undo — `POST /v1.0/subscribers/message-filter/allowed-contacts/remove`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"MessageFilterId\": \"\",\n \"Contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "afb47fa7-8289-4d05-a5b5-de7d07c04380", "name": "Allowed Contacts Added", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"AllowedContacts\": [\n \"+1111111111\",\n \"+2222222222\",\n \"+15555555555\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "409b3305-957e-4f24-a9f6-448397179cd3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "535f4c01-c143-41f6-8abb-ea81d4303ce6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bb13097-cb08-4200-8888-cd4c294f9f73", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c14beb3-853a-4e04-8cc6-ebfcd7429ce5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05543e3f-5633-4fc8-8026-48f3fae5676c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7abea20-e6be-4d97-ae55-0200f978348c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78dbe5fa-71fc-40d0-b310-b5399edfaa11", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2759d809-a0e1-4061-a68e-b4e0881fc332", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d158205-bc52-4148-9fa9-a6af2eea22a1", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13a662a4-ba44-4425-8bb6-389e0fac87d1", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ebdd3c9-7e83-4c35-b224-e57330dacf03", "name": "Remove Allowed Contacts", "request": { "name": "Remove Allowed Contacts", "description": { "content": "Remove phone numbers from the allowed contacts list.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `MessageFilterId` (`MFID-`)\n- Numbers must currently be on the allowed list — confirm with `GET /v1.0/subscribers/message-filter/allowed-contacts`\n\n**What this does:** Removes one or more phone numbers from the allowed list. After removal, messages from those contacts go through the normal filter pipeline (keyword checks, link blocking, etc.).\n\n**Next steps:**\n- Verify the removal — `GET /v1.0/subscribers/message-filter/allowed-contacts`\n- Block the contact instead — `POST /v1.0/subscribers/message-filter/blocked-contacts/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"MessageFilterId\": \"\",\n \"Contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "83f10d6d-1225-4f31-b423-99d9460d46ba", "name": "Allowed Contacts Removed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"AllowedContacts\": [\n \"+1111111111\",\n \"+2222222222\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4ec2289-279e-4db5-93e1-7cfd0364e271", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "743e757f-7a2a-4f93-9077-36231c3614e9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3f3ed70-3c7e-49be-b0da-ca443a9675c8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf3a56f-af29-4b91-8561-7c5d899e2a1d", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7a2b67d-1591-4cf5-a832-865b123a6b7c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8e7100c-6c46-413e-a549-c737c47738b3", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5b4b676-aced-42dd-ba9f-f1376cd8b4ff", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd0feb82-86d8-4552-9b23-fd68e9119456", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39bb7011-7115-4a00-9ddd-33638003c9dd", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59255f37-503a-480b-aaf1-ece0c96e7bf9", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "allowed-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "495a9579-98be-40fa-ab0a-1045838b96e0", "name": "Get Blocked Contacts", "request": { "name": "Get Blocked Contacts", "description": { "content": "View the list of phone numbers blocked from messaging a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `MessageFilterId` (`MFID-`)\n\n**What this does:** Returns every phone number currently blocked. Messages from these numbers are silently dropped — the sender receives no error or notification.\n\n**Next steps:**\n- Block a new sender — `POST /v1.0/subscribers/message-filter/blocked-contacts/add`\n- Unblock someone — `POST /v1.0/subscribers/message-filter/blocked-contacts/remove`\n- View the allowed side — `GET /v1.0/subscribers/message-filter/allowed-contacts`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "(Required) Telegent Subscriber ID. Format: `TSUID-` followed by a UUID. Create one via `POST /v1.0/subscribers/create` or look up existing IDs with `GET /v1.0/subscribers/get`." }, { "disabled": false, "key": "MessageFilterId", "value": "", "description": "(Required) Message Filter ID. Format: `MFID-` followed by a UUID. Returned by `POST /v1.0/subscribers/message-filter` (Create) or `GET /v1.0/subscribers/message-filter` (List)." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c4efcf6e-4ce1-4c0d-9bf5-25b00bd3cef0", "name": "List of Blocked Contacts", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"+3333333333\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2f628d0-3e88-4fa5-9dd8-8599edc87fbf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdc7f1f6-6582-48fc-b917-61387cd513b0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92e4a1d6-4a3d-499c-9613-fa127ece1cb9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f395e73-128e-487e-98a7-fb024a97ebf0", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "041df66e-1ed6-4b82-a711-02832aa21718", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3251b49-476b-4e57-ba99-3a54694ec1ec", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e02e087-f80b-4c16-8b4c-221f6ed97903", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "250d8683-33e4-47e0-b1f3-2803cd7c4b11", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff63f2f8-399f-4361-bc03-f77db2c83d78", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d743ac20-e0c9-4dfe-b9a5-2c89d04f5bd4", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae02d285-ac95-43e8-bb11-f760016054b1", "name": "Add Blocked Contacts", "request": { "name": "Add Blocked Contacts", "description": { "content": "Block phone numbers from messaging a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and an existing `MessageFilterId` (`MFID-`)\n\n**What this does:** Adds one or more phone numbers to the blocked list. Messages from blocked contacts are silently dropped — they are never delivered, and the sender sees no error. Common use case: preventing unwanted or harassing contacts.\n\n**Next steps:**\n- Verify the addition — `GET /v1.0/subscribers/message-filter/blocked-contacts`\n- Undo — `POST /v1.0/subscribers/message-filter/blocked-contacts/remove`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"MessageFilterId\": \"\",\n \"Contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4704c16c-043a-4161-8444-407bb16e85cb", "name": "Blocked Contacts Added", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"BlockedContacts\": [\n \"+3333333333\",\n \"+14444444444\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ae4ab6-1831-4790-8c12-8e0ff7a04bab", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef3d83f3-a799-446d-a0a3-78e47a82dd1d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fbea687-56b6-4a8f-8902-57cbe589e940", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1569a30e-a1ba-4fe9-afb0-f679c5d87c8a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a02c27d-2b41-4f5b-adb3-a0b2ca4b8813", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5905ce78-537d-4192-9b37-8390c41e5c65", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b1fbd11-2fe8-4c5b-b1f1-676f7c5f6873", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee24a1a3-d4be-4d6c-a3f1-a5d7b7f49c19", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a004e8d-9070-44c2-9583-805f7a67191e", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85ba8d10-f224-4fe9-8d4d-15d576762bc0", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+14444444444\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7793a8aa-8646-48db-bb37-c56ef11ab27d", "name": "Remove Blocked Contacts", "request": { "name": "Remove Blocked Contacts", "description": { "content": "Unblock phone numbers so their messages start being delivered again.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `MessageFilterId` (`MFID-`)\n- Numbers must currently be on the blocked list — confirm with `GET /v1.0/subscribers/message-filter/blocked-contacts`\n\n**What this does:** Removes one or more phone numbers from the blocked list. After removal, messages from those contacts go through the normal filter pipeline and are delivered if they pass the rules.\n\n**Next steps:**\n- Verify the removal — `GET /v1.0/subscribers/message-filter/blocked-contacts`\n- Add to allowed instead — `POST /v1.0/subscribers/message-filter/allowed-contacts/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"MessageFilterId\": \"\",\n \"Contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e0c62a52-2787-4a49-8cb5-b87eb428aeda", "name": "Blocked Contacts Removed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"BlockedContacts\": [\n \"+14444444444\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc480a4a-f0e4-443d-9d6e-2de10ce5c83b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b802face-75ff-47fd-b502-4db7791ec149", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b846c51-1d7b-442d-8c7f-ab2dcf4bb0a6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db7bf101-0ba6-4393-8a8f-6f7a8d2a95c5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44212ec3-591c-4996-8965-1738e011290a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1df672f7-e06c-4310-9b0a-48e41aa2cf9f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501f5221-6a3e-4ec1-a35f-c2ef19bbb28e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d73ee9ce-0a52-4ce1-ba72-7e60cfa4f6c4", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e19db29c-dd27-4ae0-9882-553b04e0baad", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "800e4f44-b461-43fd-bdef-5e55f7efc253", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "blocked-contacts", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"MessageFilterId\": \"MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1\",\n \"Contacts\": [\n \"+3333333333\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fd50013-e864-44c9-9abf-9128e6fd1770", "name": "Get Message Filter Keywords", "request": { "name": "Get Message Filter Keywords", "description": { "content": "View the keyword rules attached to a message filter.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `MessageFilterId` (`MFID-`)\n\n**What this does:** Returns the keyword filter configuration: `CustomKeywords` (your own words), `SystemKeywords` (Telegent-provided categories like Profanity, Violence), and `SeverityMap` (risk level per term: `HIGH`/`MEDIUM`/`LOW`). Use this to audit exactly what words will trigger filter actions.\n\n**Next steps:**\n- Add or change keywords — `POST /v1.0/subscribers/message-filter/update` (use the `KeywordFilter` field)\n- See the rest of the filter — `GET /v1.0/subscribers/message-filter`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "(Required) Telegent Subscriber ID. Format: `TSUID-` followed by a UUID. Create one via `POST /v1.0/subscribers/create` or look up existing IDs with `GET /v1.0/subscribers/get`." }, { "disabled": false, "key": "MessageFilterId", "value": "", "description": "(Required) Message Filter ID. Format: `MFID-` followed by a UUID. Returned by `POST /v1.0/subscribers/message-filter` (Create) or `GET /v1.0/subscribers/message-filter` (List)." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8676d843-ab68-4da9-b372-5bbb85f53e67", "name": "Message Filter Keywords", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CustomKeywords\": [\n \"inappropriate\",\n \"banned\"\n ],\n \"SystemKeywords\": {\n \"Profanity\": [\n \"word1\",\n \"word2\"\n ],\n \"Violence\": [\n \"threat1\"\n ]\n },\n \"SeverityMap\": {\n \"Word1\": \"HIGH\",\n \"Inappropriate\": \"MEDIUM\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a56cba0-f4f9-463a-b92b-bab33cac70d3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d930b32a-c266-4b03-b0e9-9cdf907040e4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "493e00e7-1e99-4b15-baa3-652be3dc9495", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74f21755-205c-4992-bffa-8d354af5ca52", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4869e7b9-3137-4145-bf19-6f073272c6d1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5753a050-4564-4901-a15a-7b1f56d7b68c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b2edfa9-5872-4bbd-8982-458e1bd2455d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5777104b-0b5b-473a-a3fb-a0e88472ee89", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "023e6124-ccd2-49a2-8d03-205c1a049557", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fef7dfe-69ad-4e37-9b74-477c7968701d", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "message-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441" }, { "key": "MessageFilterId", "value": "MFID-83ee4478-3e58-40a4-a528-b5aad4687b10" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8576d2a9-9bde-419a-9961-325172185c08", "name": "Configure Guardian Features", "request": { "name": "Configure Guardian Features", "description": { "content": "Enable or disable AI Guardian on a subscriber. This is the **first step** for every Guardian workflow — filters, keyword rules, and parent/child relationships will not function until Guardian is enabled here.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing Subscriber (`TSUID-`) — `POST /v1.0/subscribers/create`\n\n**What this does:** Turns AI Guardian on or off for the subscriber's calls and messages independently. Set `EnableIntelligentGuardianCalls` and `EnableIntelligentGuardianMessages` to `true` to enable monitoring; set both to `false` to fully disable Guardian.\n\n**Next steps:**\n- Confirm the change took effect — `GET /v1.0/subscribers/guardian-features`\n- Link a parent and child for supervision — `POST /v1.0/subscribers/guardians/relation`\n- Create a message filter — `POST /v1.0/subscribers/message-filter`\n- Create a call filter — `POST /v1.0/subscribers/call-filter`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"EnableIntelligentGuardianCalls\": \"\",\n \"EnableIntelligentGuardianMessages\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e5e91b11-08f8-4bb8-9ff7-10c692255367", "name": "Guardian Features Saved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e37677-147f-43b0-8468-dde21c0c063d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f0dbb70-0ca3-481e-b4d3-50459eaa8f28", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f8cf829-de9a-4015-a2bc-03ae7105b3a8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4eeb2a6-ebe1-4b17-ab75-7560dff54394", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3ced3dd-8e0c-4c83-9b93-5b349e0387e2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfd00f19-73dc-4f37-b723-d0d0a853916b", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeb0a2b3-b22f-4bd3-af47-0221cdfaa9f0", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6b185e9-1cfa-40d2-afbf-addf3f72cdb1", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64b8eb60-b0db-439a-9daf-bfcaa0eaed9b", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b1a2e52-e1ad-4a5b-b823-7c217dae1199", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2487dc0f-6a97-402f-a268-2eadb17b0f31", "name": "Get Guardian Features", "request": { "name": "Get Guardian Features", "description": { "content": "Check whether AI Guardian is currently enabled for a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing Subscriber (`TSUID-`)\n\n**What this does:** Returns the current `EnableIntelligentGuardianCalls` and `EnableIntelligentGuardianMessages` flags for the subscriber. Use this after toggling features to confirm the change took effect before applying filters or guardian relationships.\n\n**Next steps:**\n- Change the settings — `POST /v1.0/subscribers/guardian-features`\n- View existing filters — `GET /v1.0/subscribers/message-filter` or `GET /v1.0/subscribers/call-filter`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "(Required) Telegent Subscriber ID. Format: `TSUID-` followed by a UUID. Create one via `POST /v1.0/subscribers/create` or look up existing IDs with `GET /v1.0/subscribers/get`." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3e47a8f1-a9b8-4b1e-9f13-0f7f5d3ce585", "name": "Guardian Features Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"EnableIntelligentGuardianCalls\": true,\n \"EnableIntelligentGuardianMessages\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61d1e56b-f8c0-4db8-848f-ce26b5340f1c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06fda7d8-6ea7-480a-a1dd-710d930ab8c0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20fa3958-116e-41a3-b244-c1f17611d0ee", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0269239f-4949-41c2-a571-0ba3fde33ba9", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a010f13b-69f4-4d42-9f3b-55bbe2fe33f8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c1820e1-d05a-44b1-a009-54dabbe69fa8", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40ce762d-8a07-462e-a2cf-599b95e8a919", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ffea2de-2e93-4bbc-b23e-c5d6fae333a6", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "545b32ac-c819-45e7-aebc-a64f4fb3d2ff", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bdcabd7-033d-4513-a09b-4aab7859d2a6", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardian-features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "984d343f-fd2f-496d-83fc-bb4db562df4e", "name": "Create Guardian Relation", "request": { "name": "Create Guardian Relation", "description": { "content": "Link a parent (guardian) subscriber to a child subscriber so the parent can supervise the child's communications.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Both subscribers must exist (`TSUID-`) — `POST /v1.0/subscribers/create`\n- AI Guardian must be enabled on both subscribers — `POST /v1.0/subscribers/guardian-features`\n\n**What this does:** Creates a one-way parent-to-child link. The parent gains the ability to receive filter notifications, manage filters on behalf of the child, and use age-preset modes (`CHILD`, `TEENAGER`, `ADOLESCENT`) on the child's call filters.\n\n**Next steps:**\n- Verify the link — `GET /v1.0/subscribers/guardians/relation/parent` (lookup by parent) or `GET /v1.0/subscribers/guardians/relation/child` (lookup by child)\n- Create message and call filters on the child — `POST /v1.0/subscribers/message-filter`, `POST /v1.0/subscribers/call-filter`\n- Remove the link later — `POST /v1.0/subscribers/guardians/relation/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"\",\n \"ChildSubscriberId\": \"\",\n \"Relation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ca302fa8-f5db-4bad-a442-1b78508656ca", "name": "Guardian Relation Created", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Parent\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebaf8500-54fd-49ed-9e9c-e8f8a6481e87", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9987b4c-7aea-4907-a816-37016bc1830f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b74f603e-eae0-496c-a8be-d7468f271769", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bb386d6-966e-4589-a418-797cf9c906ca", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3435637-1efc-4d43-aa20-043d29e0d19d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2976618-df17-4ce7-91fa-a674ed1beb92", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30c5ece8-20b7-4e9d-9a86-d764916a0d44", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37bc7a2e-a376-4444-9ffb-f322d7ea2be0", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de804d19-02be-497d-a107-489a52801477", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaa9ea0e-d508-4174-803a-6cee5e2e1dcd", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98dd3a87-f88a-4ea5-8a65-8b26f40e6697", "name": "Get Guardian Relation Parent", "request": { "name": "Get Guardian Relation Parent", "description": { "content": "List every child subscriber that a parent is currently linked to.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Parent Subscriber ID (`TSUID-`)\n\n**What this does:** Returns all guardian relations where the supplied subscriber is the parent. Use this to verify a relationship was set up correctly or to audit which children a guardian oversees.\n\n**Next steps:**\n- Look up the inverse (children's guardians) — `GET /v1.0/subscribers/guardians/relation/child`\n- Remove a relation — `POST /v1.0/subscribers/guardians/relation/delete`\n- Add a new relation — `POST /v1.0/subscribers/guardians/relation`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ParentSubscriberId", "value": "", "description": "(Required) Subscriber ID of the parent (guardian). Format: `TSUID-` followed by a UUID. Both parent and child must already exist as subscribers and have AI Guardian enabled." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0accfb29-7ae7-4f93-9600-55ff7fd9b2d8", "name": "Guardian Relations Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Children\": [\n {\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Parent\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3ea7ad2-e907-475c-b2fa-d3b4a186d754", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5ebe857-212d-4539-a3e3-45ba7951c83d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11b8ec4c-4467-4bbd-b543-06dfd5aaf760", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b4287df-23a8-4c14-bb48-d1479865cb14", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04a270ef-60d1-411c-9bfd-6e5fedec2c1f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b1f614e-5c04-424a-bdf9-456ea007fe80", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf017fbe-23f1-42ad-bce7-4f25c6e5e8c1", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bdc59ac-e24f-4d4d-93af-a63406c8cff6", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9be69a3c-ea42-45a9-9388-b7b003a281c2", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15dc5afc-11c0-4bbf-9d19-d9dd3e71bca0", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "parent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ParentSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf04e4fc-76b5-4b3c-921b-0a51f5d5e290", "name": "Get Guardian Relation Child", "request": { "name": "Get Guardian Relation Child", "description": { "content": "List every parent (guardian) linked to a specific child subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Child Subscriber ID (`TSUID-`)\n\n**What this does:** Returns all guardian relations where the supplied subscriber is the child. Use this to confirm which guardians have oversight over a particular child account.\n\n**Next steps:**\n- Look up the inverse (a parent's children) — `GET /v1.0/subscribers/guardians/relation/parent`\n- Remove a relation — `POST /v1.0/subscribers/guardians/relation/delete`\n- Add a new relation — `POST /v1.0/subscribers/guardians/relation`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ChildSubscriberId", "value": "", "description": "(Required) Subscriber ID of the child (the subscriber being supervised). Format: `TSUID-` followed by a UUID." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "284e3422-1662-4a10-95e6-a5004ab7fec0", "name": "Guardian Relations Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Guardians\": [\n {\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Parent\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b0011a5-1886-4779-886d-3c123b0c320d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed4d03ba-2e50-4173-bb27-d064bd20ee35", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3be6f002-53f6-4b83-bc29-b51d6f295d2c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e39bee5a-8745-44a5-89fe-569073b9ea7f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e4bd074-2144-4fce-a700-0c336f25b577", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "327c6335-d213-4e6e-a93f-91bc2e29c509", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9f1715d-b73a-4614-85bf-530487a6c707", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3703ef74-f4e8-45ce-a272-20f7e281dc99", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a33e136a-630e-47d0-baa5-3b87fc1442d1", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9ba29d8-cf1c-45c8-8948-0fb84feea623", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "child" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChildSubscriberId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bcc2ed1b-e16d-449e-9be8-acd399acf85a", "name": "Remove Guardian Relation", "request": { "name": "Remove Guardian Relation", "description": { "content": "Unlink a parent (guardian) from a child subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing parent-child relation\n\n**What this does:** Removes the guardian relation only. The subscribers themselves and their individual filters remain untouched. After removal, the parent will no longer receive filter notifications or be able to manage the child's filters.\n\n**Next steps:**\n- Confirm removal — `GET /v1.0/subscribers/guardians/relation/parent`\n- Re-establish the link later — `POST /v1.0/subscribers/guardians/relation`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"\",\n \"ChildSubscriberId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6e270d8-6ac5-4a57-a0cd-9402fe97d309", "name": "Guardian Relation Deleted", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Status\": \"Deleted\",\n \"DateDeleted\": \"2025-11-06T20:32:49.5228131+00:00\",\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\",\n \"Relation\": \"Guardian\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20910314-13d6-488c-a1d6-81febe5cd3b0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02df4a90-db50-4cae-a445-a8444aaf57c8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4829992-7796-45aa-9650-2ce6e1636fff", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c3d9fc-812b-4ba4-81ed-4e8b50ab9b4d", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e22b8773-cf39-4d52-aae4-54eab3713be0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bbfb6cd-bd11-4eb0-95a3-996fe4e0b6d5", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ff7c8df-19f5-4d75-ab53-3c4df855c480", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5a9def4-9df9-4e27-89e3-2476b4cd6c4a", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dce1f5f8-a3a7-418e-80f2-5a58cdfb27bf", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9ce618-0919-414c-90b2-962a5e237d4d", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "guardians", "relation", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ParentSubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"ChildSubscriberId\": \"TSUID-712C771C-2326-46E8-86BA-E4E58F3DABDC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "550a54d7-2d46-4225-86b0-07c866448607", "name": "Create Call Filter", "request": { "name": "Create Call Filter", "description": { "content": "Create a new call filter that controls who can place or receive calls for a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing Subscriber (`TSUID-`) — `POST /v1.0/subscribers/create`\n- AI Guardian enabled for calls — `POST /v1.0/subscribers/guardian-features`\n- (Optional) For age-preset modes (`CHILD`, `TEENAGER`, `ADOLESCENT`): a parent-child guardian relation — `POST /v1.0/subscribers/guardians/relation`\n\n**What this does:** Creates a call filter and returns a `CallFilterId` (`CFID-`). Choose mode: `WHITELIST` (only allowed numbers ring through), `BLACKLIST` (block listed numbers, allow others), or an age preset that applies Telegent-recommended defaults. Configure transcription, keyword alerts, action on detection (warn/terminate/notify), and time-based restrictions. The filter takes effect immediately.\n\n**Next steps:**\n- Verify it was saved — `GET /v1.0/subscribers/call-filter`\n- Add allowed callers — `POST /v1.0/subscribers/call-filter/allowed-numbers/add`\n- Add blocked callers — `POST /v1.0/subscribers/call-filter/blocked-numbers/add`\n- Review keyword rules — `GET /v1.0/subscribers/call-filter/keywords`\n- Update later — `POST /v1.0/subscribers/call-filter/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c5b4c3f9-3472-4e74-9622-9dd2b4319d97", "name": "Call Filter Created", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"+1111111111\",\n \"+2222222222\"\n ],\n \"BlockedNumbers\": [\n \"+3333333333\"\n ],\n \"EnableTranscription\": true,\n \"KeywordFilter\": \"{\\\"CustomKeywords\\\":[\\\"inappropriate\\\",\\\"banned\\\"],\\\"SystemKeywords\\\":{\\\"Profanity\\\":[\\\"word1\\\",\\\"word2\\\"],\\\"Violence\\\":[\\\"threat1\\\"]},\\\"SeverityMap\\\":{\\\"Word1\\\":\\\"HIGH\\\",\\\"Inappropriate\\\":\\\"MEDIUM\\\"}}\",\n \"TranscriptionAction\": \"WARNING\",\n \"WarningMessage\": \"This call may be terminated\",\n \"NotificationPhones\": [\n \"+9999999999\"\n ],\n \"ApplyToOutbound\": false,\n \"ApplyToInbound\": false,\n \"BlockUnknownNumbers\": false,\n \"BlockInternational\": false,\n \"RecordFlaggedCalls\": false,\n \"TimeRestrictions\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac8767a-791f-4190-a570-cef884d9564a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eabee95-62d3-4019-9d73-9f017ea2faea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b152256-3288-4f60-9db5-4b1b4197a5fb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29fd01cc-c75e-469e-a527-2e3d98be7e78", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9917a963-1f6f-400d-817c-b4a6f21c83e0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5cfb5a2-a12b-43bb-b277-fc294f58b193", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02b9d0c3-22b2-4e5a-8937-4c63602006fe", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a1dc599-d7f1-4472-b488-07b06f894813", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ef44ee6-3e4d-4ae1-8dd4-b8740196171a", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "793d2459-cf42-43f3-a2f1-bb5d1237eb69", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\",\n \"TimeRestrictions\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0cefc1a-d4b1-46dd-8d8e-adb768fae9da", "name": "Get Call Filters", "request": { "name": "Get Call Filters", "description": { "content": "List the call filters configured on a subscriber or phone number.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID or phone number to filter by (otherwise returns all)\n\n**What this does:** Returns the full configuration of each matching filter — mode, allowed/blocked number lists, transcription settings, and keyword alert rules. Use this to audit a subscriber's call controls or to find the `CallFilterId` (`CFID-`) you need for subsequent calls.\n\n**Next steps:**\n- Inspect allowed/blocked lists in detail — `GET /v1.0/subscribers/call-filter/allowed-numbers`, `GET /v1.0/subscribers/call-filter/blocked-numbers`\n- View keyword rules — `GET /v1.0/subscribers/call-filter/keywords`\n- Modify a filter — `POST /v1.0/subscribers/call-filter/update`\n- Remove a filter — `POST /v1.0/subscribers/call-filter/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "Optional. Return only filters belonging to this subscriber. Format: `TSUID-` followed by a UUID." }, { "disabled": false, "key": "Phone", "value": "", "description": "Optional. Return only filters tied to this phone number. Use E.164 format (e.g., `+15555555555`)." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2ae16e68-d9c6-40fe-9d71-505ff9217ab3", "name": "Call Filters Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567890\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"+1111111111\",\n \"+2222222222\"\n ],\n \"BlockedNumbers\": [\n \"+3333333333\"\n ],\n \"EnableTranscription\": true,\n \"TranscriptionAction\": \"WARNING\",\n \"WarningMessage\": \"This call may be terminated\",\n \"NotificationPhones\": [\n \"+9999999999\"\n ],\n \"ApplyToOutbound\": false,\n \"ApplyToInbound\": false,\n \"BlockUnknownNumbers\": false,\n \"BlockInternational\": false,\n \"RecordFlaggedCalls\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7830ce4e-8290-4483-8c72-d5790a099b90", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c26a57d2-3d16-4eee-bc7b-a86eb3b7979b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2944557-8150-4053-96a5-2889892458e1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d148f0a7-1ac2-48a6-923b-3560cb5c4f47", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2a4f68a-b9c7-4562-a20d-19fc869230dd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1d51b92-b296-417d-9136-0e895ebed7cc", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "413e9547-4733-4595-88e9-0e9cb7c3a2f3", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6251f155-1ca4-4ae5-b6ef-f60f0c7052e2", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32d8b14d-1471-4965-9a31-c5418907aeb6", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d416de9-fd4b-4cce-8bc0-3df6c9b97881", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "Phone", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "470d64c3-ee1d-4ef1-a5ca-387fe071aae5", "name": "Update Call Filter", "request": { "name": "Update Call Filter", "description": { "content": "Modify an existing call filter without deleting and recreating it.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing `CallFilterId` (`CFID-`) — find one with `GET /v1.0/subscribers/call-filter`\n\n**What this does:** Replaces the configuration of the specified filter. Use this to change modes (e.g., `BLACKLIST` → `WHITELIST`), update allowed/blocked number lists, toggle transcription, change keyword alerts, or adjust restrictions like blocking unknown or international numbers. Note: the Update endpoint only accepts `WHITELIST` and `BLACKLIST` modes — age presets must be set on creation.\n\n**Next steps:**\n- Verify the change — `GET /v1.0/subscribers/call-filter`\n- Pause without deleting — use `POST /v1.0/subscribers/call-filter/update` with `EnableTranscription` off and an empty rules set, or delete the filter\n- Permanently remove — `POST /v1.0/subscribers/call-filter/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "53cee9ca-d8d2-463e-b4cf-805a5c97e027", "name": "Call Filter Updated", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"Phone\": \"+1234567891\",\n \"FilterMode\": \"WHITELIST\",\n \"AllowedNumbers\": [\n \"+1111111111\",\n \"+2222222222\"\n ],\n \"BlockedNumbers\": [\n \"+3333333333\"\n ],\n \"EnableTranscription\": true,\n \"TranscriptionAction\": \"WARNING\",\n \"WarningMessage\": \"This call may be terminated\",\n \"NotificationPhones\": [\n \"+9999999999\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff3ffc9a-034e-43d2-b335-29986fa3252c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0447db6b-8d66-4c50-9402-03cbcc053b21", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c631d2e9-b92c-4d9a-9f41-4c9dcdddf92c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "228acbcc-5e96-41c4-ab3f-62471b905249", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc52ea67-7251-4410-b966-2408ebd58c0b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13ffe8e0-6631-47b0-ade3-2314894a7100", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94844a71-b42d-4cfa-a099-facd4d3cdb69", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e022df18-d373-4259-b4fe-3ba62bf28890", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be7deaf4-1017-4ce8-91f4-51d08e939436", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0559d96-1dbf-4dc3-86da-69fdfa5b89cf", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"SubscriberId\": \"\",\n \"Phone\": \"\",\n \"FilterMode\": \"\",\n \"AllowedNumbers\": [\n \"\",\n \"\"\n ],\n \"BlockedNumbers\": [\n \"\",\n \"\"\n ],\n \"EnableTranscription\": \"\",\n \"KeywordFilter\": \"\",\n \"TranscriptionAction\": \"\",\n \"WarningMessage\": \"\",\n \"NotificationPhones\": [\n \"\",\n \"\"\n ],\n \"ApplyToOutbound\": \"\",\n \"ApplyToInbound\": \"\",\n \"BlockUnknownNumbers\": \"\",\n \"BlockInternational\": \"\",\n \"RecordFlaggedCalls\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6d92a2e-d726-45b9-8c88-7f14fbc8e153", "name": "Delete Call Filter", "request": { "name": "Delete Call Filter", "description": { "content": "Permanently remove a call filter from a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- An existing `CallFilterId` (`CFID-`)\n\n**What this does:** Permanently deletes the filter and all its associated allowed/blocked numbers and keyword rules. Calls will no longer be filtered after this call. **This cannot be undone.**\n\n**Next steps:**\n- Confirm removal — `GET /v1.0/subscribers/call-filter`\n- Create a new filter — `POST /v1.0/subscribers/call-filter`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7cecb667-1062-4c4b-bad9-46ccc8bbfb54", "name": "Call Filter Deleted", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Status\": \"Deleted\",\n \"FilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\",\n \"DateDeleted\": \"2025-11-07T00:23:57.4465319+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e69e77f6-f01c-44ba-9c6e-6d4f94b16716", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7716fbab-1dd4-47e1-a1a5-5712ba775143", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "096835f4-f3d5-412c-ad42-2a318d07d47c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d1ceb10-3c62-4338-8b51-432a7fe30eeb", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35493432-d04f-41d6-bc86-53b7e7504757", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74c2ba73-d7e2-4afa-b23b-2a1da8918c3f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e133cfe-4210-4249-8c7b-77573d5692e3", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac2eff0d-c24a-4c35-b997-17e75b12c3bf", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2ed267c-0ce8-41b4-92a0-61839f6b7df7", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25bb5db3-a00a-4cdd-89d9-fef8c958afeb", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallFilterId\": \"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9818696-eb31-4250-b533-6eb56546176d", "name": "Get Allowed Numbers", "request": { "name": "Get Allowed Numbers", "description": { "content": "View the list of phone numbers allowed to call a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `CallFilterId` (`CFID-`) — find one with `GET /v1.0/subscribers/call-filter`\n\n**What this does:** Returns every phone number on the allowed list. In `WHITELIST` mode, only these numbers can ring through to the subscriber — all other callers are blocked or sent to voicemail.\n\n**Next steps:**\n- Add a new trusted caller — `POST /v1.0/subscribers/call-filter/allowed-numbers/add`\n- Remove someone from the list — `POST /v1.0/subscribers/call-filter/allowed-numbers/remove`\n- View the blocked side — `GET /v1.0/subscribers/call-filter/blocked-numbers`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "(Required) Telegent Subscriber ID. Format: `TSUID-` followed by a UUID. Create one via `POST /v1.0/subscribers/create` or look up existing IDs with `GET /v1.0/subscribers/get`." }, { "disabled": false, "key": "CallFilterId", "value": "", "description": "(Required) Call Filter ID. Format: `CFID-` followed by a UUID. Returned by `POST /v1.0/subscribers/call-filter` (Create) or `GET /v1.0/subscribers/call-filter` (List)." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "92eec42c-13ba-458c-b6be-d6f744f477ac", "name": "Allowed Numbers Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"+1111111111\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e785ae-16a0-439a-9ad6-cdfaa650a73b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f294676d-75c7-485c-9006-e05aebe795d3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95f190e7-2e9e-48fe-af4e-d141efd5e3f0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99658a42-d259-42ba-9fcd-41bcad8d1aed", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f213313-dab6-4c3c-aea5-56d67c125909", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6591ae4f-d813-4979-8d27-5bcd616b9f7a", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6fb21c9-390d-4973-b75b-ce1c16fee1fb", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2199185-2f81-442b-9e02-5d4482b6ae06", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0250ce88-615b-40e3-9caf-80847af7acd6", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ed0afde-1c10-47a9-9538-186f0e7baa13", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87e28926-0f98-4f17-ad70-ff516ca38745", "name": "Add Allowed Numbers", "request": { "name": "Add Allowed Numbers", "description": { "content": "Add trusted phone numbers that are allowed to call a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and an existing `CallFilterId` (`CFID-`)\n- Filter is in `WHITELIST` mode for the allow list to actively gate callers (in other modes, the list is informational)\n\n**What this does:** Adds one or more phone numbers to the allowed callers list. In `WHITELIST` mode, only numbers on this list can ring the subscriber — all others are blocked or sent to voicemail. Common use case: family members, doctors, or known business contacts.\n\n**Next steps:**\n- Verify the addition — `GET /v1.0/subscribers/call-filter/allowed-numbers`\n- Undo — `POST /v1.0/subscribers/call-filter/allowed-numbers/remove`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"CallFilterId\": \"\",\n \"Numbers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7977a804-6763-423b-a936-3f76ab0e688c", "name": "Allowed Numbers Added", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"AllowedNumbers\": [\n \"+1111111111\",\n \"+15555555555\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a72d8b-544f-45d8-8d76-413d69abda93", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e7efa6b-3145-4865-9fa9-c95a8d411a02", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e19b36f-a476-47e2-8b16-7aee0d759890", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56d690ee-e274-44e6-9151-583225c17d47", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4ed7128-b681-4bf4-b54e-1371021d0d98", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "932a75cd-39c2-4c1e-b58d-098e0388ccdf", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e71f7e1f-d395-4223-9ec1-955db9f5032f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "115aa36a-6cff-4ef4-9c33-6c64d327c4ad", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a81bf3b2-143b-46f7-9630-416f66bfb0b0", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed8bc2b1-5ead-442f-80bb-f351dd0dae19", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6183ad25-3727-4e6f-a16a-8bc7f9a2bd6b", "name": "Remove Allowed Numbers", "request": { "name": "Remove Allowed Numbers", "description": { "content": "Remove phone numbers from the allowed callers list.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `CallFilterId` (`CFID-`)\n- Numbers must currently be on the allowed list — confirm with `GET /v1.0/subscribers/call-filter/allowed-numbers`\n\n**What this does:** Removes one or more phone numbers from the allowed list. In `WHITELIST` mode, calls from those numbers will no longer ring through and are treated like any other non-allowed caller.\n\n**Next steps:**\n- Verify the removal — `GET /v1.0/subscribers/call-filter/allowed-numbers`\n- Block the caller instead — `POST /v1.0/subscribers/call-filter/blocked-numbers/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"CallFilterId\": \"\",\n \"Numbers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f8b88813-db1a-45d6-8ea6-72564d07d2e1", "name": "Allowed Numbers Removed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"AllowedNumbers\": [\n \"+1111111111\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d19bb500-5a8d-4b1a-bacc-7909e95f3a2d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4edf3000-145f-4e09-a51e-4d0f4837912d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3211ee40-747c-42fd-9913-acd27380bd6c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98bc961c-4616-41ac-b645-d4c379a4cea6", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dc9df36-433a-4601-8881-48e4fd3f7409", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc4df862-9e3b-4dd7-ab36-d5148ecb95fe", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "026e92fc-9bb3-4ef9-9d28-ac7e0c696cdc", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb2a8d51-a668-4c8a-8d6e-9b122b88edc4", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaa3e254-8cda-478b-b36e-8778e0daa8b9", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2895da2f-25c1-45a2-aa29-440e1dd6ed27", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "allowed-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52b4c8eb-6b04-4c3d-8090-537108eb9956", "name": "Get Blocked Numbers", "request": { "name": "Get Blocked Numbers", "description": { "content": "View the list of phone numbers blocked from calling a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `CallFilterId` (`CFID-`)\n\n**What this does:** Returns every phone number currently blocked. Calls from blocked numbers are rejected or silently dropped — the caller may hear a disconnect tone or nothing at all.\n\n**Next steps:**\n- Block a new caller — `POST /v1.0/subscribers/call-filter/blocked-numbers/add`\n- Unblock someone — `POST /v1.0/subscribers/call-filter/blocked-numbers/remove`\n- View the allowed side — `GET /v1.0/subscribers/call-filter/allowed-numbers`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "(Required) Telegent Subscriber ID. Format: `TSUID-` followed by a UUID. Create one via `POST /v1.0/subscribers/create` or look up existing IDs with `GET /v1.0/subscribers/get`." }, { "disabled": false, "key": "CallFilterId", "value": "", "description": "(Required) Call Filter ID. Format: `CFID-` followed by a UUID. Returned by `POST /v1.0/subscribers/call-filter` (Create) or `GET /v1.0/subscribers/call-filter` (List)." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ed199758-e7f9-419d-8acb-40dde19a8121", "name": "Blocked Numbers Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"+3333333333\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4898011a-6a06-4ac8-82d9-15e3da2500f5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5653e62-3901-4618-961f-4e1f2d5a2064", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "909de801-10da-4d9b-b299-8c5214bdf581", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "645925ce-7e70-454f-814e-4f53225293a7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65dda37d-b678-43fc-9fb3-e80dcd477274", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39300ea6-1e9d-4bb2-967b-d87e0ba12958", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f51deada-595c-4ebd-ae13-5d1019b3226c", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5e1b10c-4d21-47c4-ba18-95a9b3f0466a", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d62e3ea0-8368-4467-8b12-ee2b0424ba3d", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5100712-611d-41ca-9350-799e1026961b", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2587f6f6-7703-410b-9dd3-7c0511176adf", "name": "Add Blocked Numbers", "request": { "name": "Add Blocked Numbers", "description": { "content": "Block phone numbers from calling a subscriber.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and an existing `CallFilterId` (`CFID-`)\n\n**What this does:** Adds one or more phone numbers to the blocked list. Calls from blocked numbers are rejected or silently dropped — the caller may hear a disconnect tone or nothing at all. Common use case: preventing unwanted, scam, or harassing callers from reaching a subscriber.\n\n**Next steps:**\n- Verify the addition — `GET /v1.0/subscribers/call-filter/blocked-numbers`\n- Undo — `POST /v1.0/subscribers/call-filter/blocked-numbers/remove`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"CallFilterId\": \"\",\n \"Numbers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bb71d901-d970-40c6-982a-9270598f9f5b", "name": "Blocked Numbers Added", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"BlockedNumbers\": [\n \"+3333333333\",\n \"+15555555555\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daa61206-e8ea-4eb2-8a94-05023074fdce", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24fa5b81-0e40-40e3-b6e1-db4785fac7fb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f34a609-9b89-4801-b84c-b422f114b70e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d2b1d53-4fd6-4842-bffb-fc1392306d56", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb76b1bc-25b9-4bee-adaa-e8198104e8f6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11d0cfdc-1930-44e9-be5f-3de08163ff8d", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0545e94-7838-437b-8a9f-c51847c50218", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a106e10a-2ed0-47f5-b26e-a248252877ac", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539b1d21-576f-41f2-998c-e4542353fc54", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50ba82ab-40b0-4688-b8dc-8fdd773d8537", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9293c3ea-7741-4dd1-8624-9ba68148e14c", "name": "Remove Blocked Numbers", "request": { "name": "Remove Blocked Numbers", "description": { "content": "Unblock phone numbers so they can call the subscriber again.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `CallFilterId` (`CFID-`)\n- Numbers must currently be on the blocked list — confirm with `GET /v1.0/subscribers/call-filter/blocked-numbers`\n\n**What this does:** Removes one or more phone numbers from the blocked list. After removal, calls from those numbers are handled normally according to the active filter mode (e.g., they will ring through in `BLACKLIST` mode unless they're caught by another rule).\n\n**Next steps:**\n- Verify the removal — `GET /v1.0/subscribers/call-filter/blocked-numbers`\n- Add to allowed instead — `POST /v1.0/subscribers/call-filter/allowed-numbers/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"CallFilterId\": \"\",\n \"Numbers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c8cc5dfe-9f94-4395-8b27-659fc0b11edd", "name": "Blocked Numbers Removed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"BlockedNumbers\": [\n \"+3333333333\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b978e01b-16e5-466a-8873-029648f4c24d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4c16bee-0704-4299-942a-589e29f85552", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c65cc1a9-90a2-4e57-b83b-8d174a315c99", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3fc2ba7-c766-407e-a668-0d314cc91a27", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "183162fa-ed6d-49a9-87de-ff90b6227457", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3d34b8a-6056-4159-9986-96a9d55ef615", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96b95826-f49f-48da-a6fd-e2c225615a3a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "564f59ee-a676-4984-a381-9744c746325b", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2682c3d-2c6e-4981-97ff-cab56ca41d47", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a08fd9c-41a3-498f-bdc3-c23ef4c084e2", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "blocked-numbers", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441\",\n \"CallFilterId\": \"CFID-8e966d20-08b8-42bf-a11f-2fdf72c663d6\",\n \"Numbers\": [\n \"+15555555555\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa16d15f-ef9a-4c70-b666-dea4989436e2", "name": "Get Call Filter Keywords", "request": { "name": "Get Call Filter Keywords", "description": { "content": "View the keyword monitoring rules attached to a call filter.\n\n**Prerequisites:**\n- Bearer token — `POST /v1.0/oauth2/tokens`\n- Subscriber ID and `CallFilterId` (`CFID-`)\n- Call transcription must be enabled on the filter for keywords to take effect at runtime — set `EnableTranscription` to `true` via `POST /v1.0/subscribers/call-filter/update`\n\n**What this does:** Returns the keyword filter configuration: `CustomKeywords` (your own words), `SystemKeywords` (Telegent-provided categories like Profanity, Threats), and `SeverityMap` (risk level per term: `HIGH`/`MEDIUM`/`LOW`). When transcription is on, calls are analyzed against these keywords and the configured `TranscriptionAction` is taken when a match is found.\n\n**Next steps:**\n- Add or change keywords — `POST /v1.0/subscribers/call-filter/update` (use the `KeywordFilter` field)\n- See the rest of the filter — `GET /v1.0/subscribers/call-filter`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriberId", "value": "", "description": "(Required) Telegent Subscriber ID. Format: `TSUID-` followed by a UUID. Create one via `POST /v1.0/subscribers/create` or look up existing IDs with `GET /v1.0/subscribers/get`." }, { "disabled": false, "key": "CallFilterId", "value": "", "description": "(Required) Call Filter ID. Format: `CFID-` followed by a UUID. Returned by `POST /v1.0/subscribers/call-filter` (Create) or `GET /v1.0/subscribers/call-filter` (List)." }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "14361b58-2e8a-4079-b674-a2a8d516fd97", "name": "Keywords Retrieved", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CustomKeywords\": [\n \"inappropriate\",\n \"banned\"\n ],\n \"SystemKeywords\": {\n \"Profanity\": [\n \"word1\",\n \"word2\"\n ],\n \"Violence\": [\n \"threat1\"\n ]\n },\n \"SeverityMap\": {\n \"Word1\": \"HIGH\",\n \"Inappropriate\": \"MEDIUM\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed1fb34e-f774-44b9-a326-61d33f81aad6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "524461f3-11dc-47e0-a5e4-05829214c5c9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65f2877e-ec8d-40d0-bdeb-5b7a9a5f071c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85509f17-4850-486d-bb15-05bbd2639102", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7cc4285-199d-4c86-9f1e-196cc0ae297d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdcfc1aa-56ad-4fdc-9d0a-10869b15efef", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f527e72-5979-4749-87b3-8c555cd69391", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9643701a-05d9-449a-b516-173a4e28edeb", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c70b6bc9-cc49-4cbb-b1f8-6f501067c9b1", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9efd678b-c6c0-4ef6-b065-df4eceb6dfb0", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscribers", "call-filter", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriberId", "value": "" }, { "key": "CallFilterId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f5b3dd0c-ff69-488f-93b2-5d5df3547470", "name": "Subscriptions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "eb4025b8-fbcf-4afa-97ac-1dfd1e3eaa38", "name": "Get Subscription Details", "request": { "name": "Get Subscription Details", "description": { "content": "Retrieve detailed information about a specific subscription by its SubscriptionId. Returns subscriber, package, phone number, and status information.\n\n**What this does:** Returns the subscription record including the linked subscriber (`TSUID-`), package (`PID-`), phone number (`NID-`), ICCID, subscription type, and active status. Use this to confirm a subscriber's current plan or retrieve the `SUB-` ID for updates.\n\n**Next steps:**\n- Update subscription — `POST /v1.0/subscriptions/update`\n- Delete subscription — `POST /v1.0/subscriptions/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriptionId", "value": "", "description": "The unique subscription ID to retrieve details for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d0c8e8a3-548e-4c6d-8cff-623cec425692", "name": "Subscription Details", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cef90273-cc1e-41d5-b87d-401fd4da623b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396e5d24-de5d-42e7-803d-4cba7a1db13b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abbd2569-ad4b-41b2-9253-3d09a5f2c196", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8522c730-b9a4-427a-a65f-51d9bc8c0457", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e3a6892-2991-4516-862b-61da0f49cb4d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20a3f8b3-465a-4c7c-81b9-ad32b44e4e27", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f7e1020-16e3-4103-8be5-508e42c443be", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ad16fca-4ab2-46fc-9513-b63cfb24e59d", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23133c86-8a8b-4642-b558-84254fdcf70b", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b6f1649-7a73-41a3-8b51-8475bb7169d0", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52f8fa1c-0cc8-4f52-831e-6beaca7a5e16", "name": "Create Subscription", "request": { "name": "Create Subscription", "description": { "content": "**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Required:** Package ID (PID) — `POST /v1.0/packages`\n- **Required:** Subscriber ID (TSUID) — `POST /v1.0/subscribers/create`\n\n---\n\nLink a subscriber to a package to grant them access to a set of services. A subscription ties together a subscriber (TSUID), a package (PID), and optionally a phone number (TNID) and SIM card (ICCID). The subscriber, package, and phone number must all exist before creating the subscription. Active subscriptions determine what services and capabilities are available to the subscriber.\n\n**What this does:** Returns the new `SubscriptionId` (`SUB-`) and full subscription record. Creating a subscription links the subscriber to a package, granting them the services and capabilities defined in that package.\n\n**Next steps:**\n- Confirm the subscription — `GET /v1.0/subscriptions`\n- View the package contents — `GET /v1.0/packages/items`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"\",\n \"PackageId\": \"\",\n \"Type\": \"\",\n \"TNID\": \"\",\n \"ICCID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a8ec4195-c19b-4d63-9211-188ca3b3512a", "name": "Success — returns the new Subscription ID (SUB-) and associated details", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1366b96d-5657-42b6-a85e-b2c92748d215", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a941a5d0-6ddf-489a-b818-ef053cc686f9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "780aca51-cd34-4381-9c7f-e34c46f121be", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d21f6ed-05de-4be6-8970-8df0b1eaf19a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05ce52d0-45db-4f55-a9f3-9b19674a26f3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1142ac0b-65bf-4b90-9ed4-76386a30520a", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65279f2-32ef-4210-a545-2d068542860f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11ac660-bdbf-4d32-a189-bdd65fa21108", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52044d46-774b-4339-9362-21b349d586a0", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad99562d-4d32-4c57-a019-5c87b04fd7c1", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SubscriptionId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4ebea49-4359-4aaf-99b5-17db996e59b2", "name": "Update Subscription", "request": { "name": "Update Subscription", "description": { "content": "Update an existing subscription's information including subscriber, package, phone number, or SIM card associations.\n\n**What this does:** Returns the updated subscription record. Only fields you send are changed; omitted fields retain their current values. Use this to swap a subscriber's package or update the associated phone number.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"\",\n \"SubscriberId\": \"\",\n \"TNID\": \"\",\n \"ICCID\": \"\",\n \"PackageId\": \"\",\n \"Type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e50159b3-f68e-4c44-9819-b2d8d42c32d3", "name": "Update Subscription", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e7bdd89-e9a9-48d4-bf68-6d090fc6e60c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc3aacde-0cb6-43f7-a743-43ee1e9a0a92", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aceb194-4d1e-4c8a-a542-6bb367985fe2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d8a89df-86ac-4081-beed-5148ddc39b57", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21836d31-a7a3-46ca-a8cc-256e3c47050d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1a01057-aefb-450c-99cc-789c8ada7850", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60698448-b953-4a80-976d-c80256ba6727", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95158639-7d2b-4d19-bb13-a3086218038b", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeab9f69-1f64-44fd-ab2f-3f6bb7bc5998", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00446d20-7deb-499d-950a-fafe7190eae6", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriberId\": \"TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d\",\n \"TNID\": \"NID-B5B67F02-708A-1851-20DF-61FC1919C4F6\",\n \"ICCID\": \"8901240397190002080\",\n \"PackageId\": \"PID-9a8435dc-ca6e-4a98-b761-5e6dc04447db\",\n \"Type\": \"mvno\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8621593-cc23-4a84-bcc5-3b7c2ca6520b", "name": "Delete Subscription", "request": { "name": "Delete Subscription", "description": { "content": "Permanently delete a subscription by its SubscriptionId. This removes the subscriber's access to the associated package.\n\n**What this does:** Returns a deletion confirmation. Deleting a subscription removes the subscriber's access to the associated package and its services. The subscriber and phone number are not deleted.\n\n**Next steps:**\n- Create a new subscription — `POST /v1.0/subscriptions`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a3be0747-608f-40a7-9f58-139b944c4dc8", "name": "Delete Subscription", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"SubscriptionStatus\": \"Deleted\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b326efd-e70d-4eb3-aa42-42aecb242652", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f50f7eb4-ae73-4a45-9206-68fc53b0d83b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dace8dfa-82ed-4271-a0c9-10ce12bfe250", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "414d064e-880b-4067-ad12-70987d17f7d9", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9b29e05-18f6-422e-aaa4-dbb1f1ad1201", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65f9afe5-cff8-4068-9bdd-d9be9b703b20", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42f4b808-8af6-4343-aacb-07d25695388e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "570f9ef4-38f1-4a82-8fd9-c43e3b2cde69", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f6b45a-e8eb-4338-964b-2d9f3faf72c4", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96d356d9-ed7e-4f56-a454-30572bc36864", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c15758e-9b12-49d0-8b08-16a63fe4adc6", "name": "Get Threshold", "request": { "name": "Get Threshold", "description": { "content": "Retrieve the details of a specific usage threshold by its `ThresholdId`. Thresholds define a resource limit (data, SMS, or voice) and the action to take when that limit is reached.\n\n**What this does:** Returns the threshold record including its name, type, amount, unit, and action. Use the `ThresholdId` query parameter to look up a single threshold.\n\n**Next steps:**\n- Create a threshold — `POST /v1.0/subscriptions/thresholds/add`\n- Assign it to a subscription — `POST /v1.0/subscriptions/thresholds/assignments/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ThresholdId", "value": "", "description": "ThresholdId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3927ab2d-1a55-474f-a87f-dcdbe86b0ba1", "name": "Threshold details", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b425999-e8d0-42f0-9f75-a61307aea7db", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84b9b2b2-6d42-4c52-847e-bb6572313b31", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ae76b27-7d11-4dec-a20b-a98183900a9a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f9b499-4ef4-4ee8-8934-158c9e8b7eeb", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b78875cf-b6fc-4c64-99bc-92e5016c7a81", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2372eed6-990b-42ad-936b-2e477430491c", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "471df21e-2bf0-451c-b79c-cb9e461da031", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7403798-7b4a-4d95-9b53-3f2183c98f88", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45d08084-83a5-4fe4-a51c-2e9831d89237", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7160feb9-348e-40dc-a6c4-a73f64ba2107", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6470fc2b-a4f3-4f2e-96e7-cd21c4e6a65e", "name": "Create Threshold", "request": { "name": "Create Threshold", "description": { "content": "Create a new usage threshold that can be assigned to subscriptions. A threshold specifies a resource type, a trigger amount, and the action to take when that amount is reached — such as sending an alert or pausing service.\n\n**What this does:** Returns the new `ThresholdId` and full threshold record. After creating a threshold, assign it to one or more subscriptions using `POST /v1.0/subscriptions/thresholds/assignments/add`.\n\n**Next steps:**\n- Assign the threshold to a subscription — `POST /v1.0/subscriptions/thresholds/assignments/add`\n- View threshold details — `GET /v1.0/subscriptions/thresholds`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"ThresholdName\": \"\",\n \"ThresholdType\": \"\",\n \"ThresholdAmount\": \"\",\n \"ThresholdUnit\": \"\",\n \"ThresholdAction\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e051b4fb-c1c3-4000-94f1-1df7c369cccd", "name": "Success — returns the new threshold ID and record", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2637e77b-0ffe-4822-b2c9-dfb0d1cdb8f8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0972ab7b-1935-47da-88ec-997ebf7f511d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06d5b4b7-2cd3-4470-b715-72ac93217d25", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "583f9cca-cedd-4c77-9b4c-251314c7b1a7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f570d71-c06b-4ff2-ac77-aa3c1bd8d435", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5260307-b096-4a1d-bc81-7a53cfd16a6a", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "328e4817-ba5b-46a9-a74f-b6ed242610f6", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4cbc23c-2dc0-4800-8763-355dbca07ad4", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c85d10c9-96d5-42c6-9b6b-526dc0d2bcc2", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68114896-6495-460f-980a-8e2cd5c6b058", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5190204-fb0f-489b-a550-c673d9278765", "name": "Update Threshold", "request": { "name": "Update Threshold", "description": { "content": "Update the configuration of an existing threshold. Only the fields you include in the request body are changed; omitted fields retain their current values.\n\n**What this does:** Returns the updated threshold record. Changes take effect on all subscriptions already assigned this threshold.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/subscriptions/thresholds`\n- View assignments — `GET /v1.0/subscriptions/thresholds/assignments`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"\",\n \"ThresholdName\": \"\",\n \"ThresholdType\": \"\",\n \"ThresholdAmount\": \"\",\n \"ThresholdUnit\": \"\",\n \"ThresholdAction\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f2eaba22-9d0f-4bca-a224-036fe05e30c9", "name": "Updated threshold record", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"AccountId\": \"AID-1234567\",\n \"ThresholdName\": \"80% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 80,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Alert\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acf9abc9-09a2-4506-bc62-54115dae755c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17dad1b3-ea8d-4242-8b1e-f4cc1dff15ce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "628c95db-1a70-4138-ad7a-c3c7e238ac0c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f869f43-5133-4b94-8ddb-a224a3b893d2", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65d16329-85be-48be-a1be-ecd50d411a71", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea8b4912-8ec8-4f7d-9226-57122ac4be97", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88126706-de0e-4eb7-bad9-8611f4f645c1", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21f9571d-ffd2-4581-898a-26b0dc2910d8", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1999a162-904e-487c-be62-1e9516719516", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4a2f568-7e19-4537-9b59-eb687fac18f7", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdName\": \"90% Data Alert\",\n \"ThresholdType\": \"Data\",\n \"ThresholdAmount\": 90,\n \"ThresholdUnit\": \"MB\",\n \"ThresholdAction\": \"Pause\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc9f0e0b-1735-401e-a2bc-5411558e3c6c", "name": "Delete Threshold", "request": { "name": "Delete Threshold", "description": { "content": "Permanently delete a threshold by its `ThresholdId`. Deleting a threshold also removes all of its assignments from associated subscriptions.\n\n**What this does:** Returns a deletion confirmation. Any subscriptions previously assigned this threshold will no longer have a threshold applied.\n\n**Next steps:**\n- Create a replacement threshold — `POST /v1.0/subscriptions/thresholds/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ef6ba0e0-2ae3-4aa9-b224-e7ef2b88f873", "name": "Threshold deleted", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"ThresholdStatus\": \"Deleted\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41cce5f7-2223-4f5a-8b46-c3510e58992c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "632067e9-643e-4c15-82a0-79120ddce82d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6740e7e-ab1e-48fd-8089-10fe6bfa174c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dd5aa52-a9e8-4089-b937-388f8e9f83d9", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7dd9046-9f02-47a7-a8b9-efc2819baf82", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a44d9c18-0a5a-4539-b870-08da34fd4f81", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f17b801-4263-4df3-a7e9-3e3f51ce92b7", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8617469f-e7af-420c-b308-e5f92a365f28", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1086b8db-3613-4caf-a30f-2c25bf3e2ef0", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f818ab95-f35c-4ac1-b448-b0343dfb95ea", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6a2904b-d870-43d7-b892-302b851ccea1", "name": "Get Threshold Assignments", "request": { "name": "Get Threshold Assignments", "description": { "content": "Retrieve all assignments for a given threshold. Each assignment links a threshold to a subscription, enabling the threshold to trigger on that subscription's usage.\n\n**What this does:** Returns a list of assignment records for the specified `ThresholdId`, including the linked `SubscriptionId` and assignment status.\n\n**Next steps:**\n- Add an assignment — `POST /v1.0/subscriptions/thresholds/assignments/add`\n- Remove an assignment — `POST /v1.0/subscriptions/thresholds/assignments/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ThresholdId", "value": "", "description": "ThresholdId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "60aef79e-cf0f-47b8-af11-d017cd63a3e1", "name": "List of threshold assignments", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"Active\": true\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f8d5202-aca8-4bb6-b8a3-8d3a379a3d01", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2af85561-a25a-468b-8f13-27e0fa56876c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01ab3de4-3832-4086-a03d-3be64bc01569", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e521de5e-1bda-47b1-8a1b-553471148992", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37431cbf-3687-45e4-b398-00c2083ad35d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca708043-5723-42d5-a2ec-33714ade787b", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39e8de39-a86a-403b-94ae-2b675136039d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fc2150b-5802-4e74-990c-9f0055cd3ac4", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90276b69-f4ae-494a-bf48-1266c1d633fe", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71fa5ceb-cade-4e9c-b3a6-d175a5680d36", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ThresholdId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c113abb7-872d-48d0-a6b7-f828933adc5a", "name": "Create Threshold Assignment", "request": { "name": "Create Threshold Assignment", "description": { "content": "Assign an existing threshold to a subscription. Once assigned, the threshold monitors that subscription's resource usage and fires its configured action when the limit is reached.\n\n**What this does:** Returns the new `ThresholdAssignmentId` and assignment record. A threshold can be assigned to multiple subscriptions; each assignment is tracked independently.\n\n**Next steps:**\n- View all assignments for this threshold — `GET /v1.0/subscriptions/thresholds/assignments`\n- Remove the assignment — `POST /v1.0/subscriptions/thresholds/assignments/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"\",\n \"SubscriptionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7ad5fe82-bf44-479f-b3e1-58a80d419f00", "name": "Success — returns the new threshold assignment ID and record", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "022c3228-3e42-4416-81be-6b6dfdadaa75", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "223a5a97-d36e-4e6e-947a-d38f01ece553", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6f5436f-f0da-412c-ad7c-bedb9cf4be71", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab09537c-c44f-4ecb-8f43-3a9a8c57967e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8983599d-5fbd-46cb-9f87-8de3f1ec57af", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c319adb2-40df-4950-a26f-84e3e89d833f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45876d49-ed9f-4859-8055-070bd5b9c9c5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f00ef856-60f0-4016-a451-fe37ac624e97", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "025fac09-caae-47ff-8f2e-d3746accbe74", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d524cdc-452a-40f7-aeb0-9aff606c7780", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b96dc803-daba-449d-8971-cbaa7a295cb2", "name": "Update Threshold Assignment", "request": { "name": "Update Threshold Assignment", "description": { "content": "Update an existing threshold assignment — for example, to re-point it to a different subscription or threshold. Only included fields are changed.\n\n**What this does:** Returns the updated assignment record.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/subscriptions/thresholds/assignments`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"\",\n \"ThresholdId\": \"\",\n \"SubscriptionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9eda61ba-5b8b-4cb6-b56f-27f1ab716326", "name": "Updated threshold assignment record", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e7aee45-3eed-44dd-b2fd-7be8af775812", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "569bd78a-aa2c-41d8-a7c9-d362ee0be1ee", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "871111a2-108d-43da-a68d-f7ddf3627c6f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bcdce6a-c0d9-4772-afb1-bf61beb0daef", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ef25a22-ce84-4671-807e-0bd1b8b4bacf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "708ddbee-36cd-4b9d-ad6b-ee09db65c683", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0b907e3-6cb9-42b1-9d1c-844c0ae8e369", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83c9e973-88a3-4275-bcdc-72021119e954", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f2aaabb-4604-4700-a111-3098753e373c", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0779372e-3178-4169-8642-2d2a84989ada", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdId\": \"THID-a1b2c3d4-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a262a052-6764-45d5-b869-18cb38bf50de", "name": "Delete Threshold Assignment", "request": { "name": "Delete Threshold Assignment", "description": { "content": "Remove a threshold assignment by its `ThresholdAssignmentId`. This unlinks the threshold from the associated subscription; the threshold itself is not deleted.\n\n**What this does:** Returns a deletion confirmation. The subscription will no longer have this threshold applied to its usage.\n\n**Next steps:**\n- Re-assign the threshold — `POST /v1.0/subscriptions/thresholds/assignments/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "25a27bab-850f-4b02-871e-cfc84776b896", "name": "Threshold assignment removed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\",\n \"ThresholdAssignmentStatus\": \"Deleted\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bc83214-d091-4d22-bdbb-d77491846f7c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a204bf-389b-49ea-8a6a-d6729033ee3e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "404031b7-f1c6-46b6-9c73-781786a81422", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dee48745-00fe-49c0-8441-cba796601b88", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "247057e5-c368-482f-93de-faffee2837fd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37e3ea39-71d3-4578-8b4d-869104f85d78", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b13dade6-ce6a-4ed1-831f-17da743ba261", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da523889-358a-404f-a02f-4fa51abf2d96", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f1b62a9-6067-4105-9d75-d2051f487dcd", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14f86cd6-cb2e-4c37-8baf-4a3de338d9c5", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "thresholds", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ThresholdAssignmentId\": \"TAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e0c8831-47db-41e4-ba9f-6d2c498bb1d6", "name": "Get Feature", "request": { "name": "Get Feature", "description": { "content": "Retrieve the details of a specific feature by its `FeatureId`. Features represent add-on capabilities (such as roaming, VoIP, or data boosters) that can be assigned to subscriptions.\n\n**What this does:** Returns the feature record including its name, type, and description. Use the `FeatureId` query parameter to look up a single feature.\n\n**Next steps:**\n- Create a feature — `POST /v1.0/subscriptions/features/add`\n- Assign it to a subscription — `POST /v1.0/subscriptions/features/assignments/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "FeatureId", "value": "", "description": "FeatureId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "09ce75a7-9229-4670-8b12-9d670a9c8446", "name": "Feature details", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edb302a6-7111-42d3-9eb0-e8c185787b05", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65b540c0-e6c4-4986-ae60-a2e7b075852a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7615fe3a-f1e1-4896-9221-48fadd000e74", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ecfa38-8030-41cb-aeff-a54ebcca2caf", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f46bbee9-7eb1-441a-b803-c16df6186f08", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a38a90a9-280e-47de-a0e5-7248830e6db5", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4deccfef-3cea-4356-a85f-6138daabdc66", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "312066ed-07bc-4d85-beff-76feb597ab43", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "027be1cc-209e-4a92-b878-3d685ef74a8b", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e4ae5d6-50da-4ae8-a78d-61e9b9bcfd3a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ecb4f091-8553-44b1-88c3-960c0a57db31", "name": "Create Feature", "request": { "name": "Create Feature", "description": { "content": "Create a new feature that can be assigned to subscriptions. Features represent optional add-on capabilities such as international roaming, VoIP, SMS bundles, or data speed tiers.\n\n**What this does:** Returns the new `FeatureId` and full feature record. After creating a feature, assign it to subscriptions using `POST /v1.0/subscriptions/features/assignments/add`.\n\n**Next steps:**\n- Assign to a subscription — `POST /v1.0/subscriptions/features/assignments/add`\n- View feature details — `GET /v1.0/subscriptions/features`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"FeatureName\": \"\",\n \"FeatureType\": \"\",\n \"FeatureDescription\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "333307e8-e697-4e70-ba26-ce107e159887", "name": "Success — returns the new feature ID and record", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea55575-18b8-4305-b857-303eebb7aaac", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0c6a611-b525-496a-a654-298ea0a70156", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "291e837e-cb26-47d3-8a06-7687414c9c9e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19dd024b-80fb-4096-8d80-528234aabc05", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc2f43be-6203-4c48-9a06-2c01c89a5806", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0fed4e-4fe4-46ec-8f5c-bdaaeaf79599", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f31cba9f-3e94-41c9-a66f-db0403f3399f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "764daa2e-aa6a-4bea-9ebf-4b3761e98e21", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e89d671f-db2c-42cc-ac64-dce6376be75c", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5075c34a-4439-4606-8229-8bf4b4091318", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79358294-0faf-4761-a796-17747f46023c", "name": "Update Feature", "request": { "name": "Update Feature", "description": { "content": "Update the details of an existing feature. Only the fields you include in the request body are changed; omitted fields retain their current values.\n\n**What this does:** Returns the updated feature record. Changes apply to all subscriptions currently assigned this feature.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/subscriptions/features`\n- View assignments — `GET /v1.0/subscriptions/features/assignments`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"\",\n \"FeatureName\": \"\",\n \"FeatureType\": \"\",\n \"FeatureDescription\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a0433ccd-4919-4a05-a714-ad842ff24aa6", "name": "Updated feature record", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"AccountId\": \"AID-1234567\",\n \"FeatureName\": \"International Roaming\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data and voice while roaming internationally.\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42e6396d-f480-4ad5-8a01-febbfe9a29ce", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5990f161-c9f6-45c9-9a27-f01fd1eb922e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "146add62-6997-432e-a594-9b359676ebff", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a57632-d99c-4d7d-ad7a-0e1563cd9f8b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3095cec6-8571-4239-89d2-bb04d5c5993e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "845c7481-6b65-4040-b4df-59dc40f31092", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4c4d192-4133-41c7-9252-5ec7d30b6118", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "243e41d1-92b6-4774-8cb2-36b2c5388d65", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a416abab-2e3d-4c0b-8cb2-87ef7d721508", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92200f99-6ecf-44dc-9f98-2c4764df38f2", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureName\": \"Global Roaming Plus\",\n \"FeatureType\": \"Roaming\",\n \"FeatureDescription\": \"Enables data, voice, and SMS while roaming internationally.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1e86f39-400a-4e23-bbdc-96bc49f515d4", "name": "Delete Feature", "request": { "name": "Delete Feature", "description": { "content": "Permanently delete a feature by its `FeatureId`. Deleting a feature also removes all of its assignments from associated subscriptions.\n\n**What this does:** Returns a deletion confirmation. Subscriptions previously assigned this feature will lose access to the capability it provided.\n\n**Next steps:**\n- Create a replacement feature — `POST /v1.0/subscriptions/features/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23dc0394-9d0f-4eb6-aaa5-30cc8ec8fdac", "name": "Feature deleted", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"FeatureStatus\": \"Deleted\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d1cf020-a9ea-4cc3-a0fd-200f755e9b03", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdb41ac4-8d5f-44b6-87e5-b4c85b4c6d2c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1efee6bc-1b46-412c-a04c-b616e5d7c40e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f61d596a-d0aa-4e02-b2d4-5ebd2d0d7bce", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5183c7a5-5f3b-49f7-a039-5769e6dcbdfb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad0d3143-c2be-483f-83d1-fd33553524ae", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f56236c0-d7e1-4357-8abd-ac44e8c65b73", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "166ac987-d62d-4b86-a1cd-c1c8afcc72d7", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e87e0d06-c496-4a56-a6fe-d92eb453ab76", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c19356-b01e-4102-b27f-7fd62414bd7f", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d5c416d-47a1-43fb-8746-872c0d41adf3", "name": "Get Feature Assignments", "request": { "name": "Get Feature Assignments", "description": { "content": "Retrieve all assignments for a given feature. Each assignment links a feature to a subscription, enabling that subscription to use the feature's capability.\n\n**What this does:** Returns a list of assignment records for the specified `FeatureId`, including the linked `SubscriptionId` and assignment status.\n\n**Next steps:**\n- Add an assignment — `POST /v1.0/subscriptions/features/assignments/add`\n- Remove an assignment — `POST /v1.0/subscriptions/features/assignments/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "FeatureId", "value": "", "description": "FeatureId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "05546e21-f012-4c47-b431-dbd613b0756b", "name": "List of feature assignments", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"Active\": true\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dc2b139-857d-4aa2-b30a-6bc43532213d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff9688e9-d32d-45df-9db3-28cdcf9c44d1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1018d19f-dabb-4db1-9df2-2a8cb02eaaab", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255f19fe-14ac-4833-b87b-7515860a218b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "056c4b34-5edb-4c0a-adbf-9130121e93c4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "895a0c75-0041-4245-bb34-1ddfeb31f895", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ba91a9e-a9b4-4625-9aed-c3de6b15d196", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b9da333-450a-45aa-aa5d-2007c8d614f9", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6c57200-7720-4dd3-af07-f3786d0175f2", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e728e64a-b875-4b94-86d2-7c8d3729e780", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FeatureId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1498778-8087-4236-8c35-2b112832f22a", "name": "Create Feature Assignment", "request": { "name": "Create Feature Assignment", "description": { "content": "Assign an existing feature to a subscription, enabling that subscription to use the feature's capability.\n\n**What this does:** Returns the new `FeatureAssignmentId` and assignment record. A feature can be assigned to multiple subscriptions; each assignment is tracked independently.\n\n**Next steps:**\n- View all assignments for this feature — `GET /v1.0/subscriptions/features/assignments`\n- Remove the assignment — `POST /v1.0/subscriptions/features/assignments/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"\",\n \"SubscriptionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a25e6834-9b80-40f0-9187-84970e5afc62", "name": "Success — returns the new feature assignment ID and record", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8690141d-ffa3-4f9d-9c05-07b93cc05956", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9314d5a9-b3c0-4b31-a499-0062af6ba490", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f63004b2-4133-49cb-b07f-ea9a53168765", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea11583d-f673-416f-8623-dabfd8ae3efc", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c749d69e-a6a2-4ab5-9e63-98f02632f96e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfcdbd2d-d8f6-4ea2-ab46-380ed0e14c90", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb94c51-f8ca-42cc-a9a5-c135b34705fd", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0e24aa3-f68b-45c4-bc98-28b03ed4d28d", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae0458a6-112e-4bb8-8584-5115fd7b4e84", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0a1ed43-5509-4411-aeb6-84251710ae2a", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b6b66cd-9630-4fd8-8e82-4640f5b54507", "name": "Update Feature Assignment", "request": { "name": "Update Feature Assignment", "description": { "content": "Update an existing feature assignment — for example, to re-point it to a different subscription or feature. Only included fields are changed.\n\n**What this does:** Returns the updated assignment record.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/subscriptions/features/assignments`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"\",\n \"FeatureId\": \"\",\n \"SubscriptionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5f0744f5-64be-4f1e-bb8a-96de85cfe1db", "name": "Updated feature assignment record", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\",\n \"Active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27fcf05a-c68c-4c15-81ce-10940fc53d37", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "321410be-dd1c-4551-8291-8c73103dcbc2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d4fc405-14c0-421d-8b64-d9ea4f65256c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca0ee518-b1d4-4783-a4ec-fd2f7eba0b5f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25bb3597-031a-4e13-a4da-cb3b5075da49", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc2fe7cb-c29c-48ec-92ac-c05b77ba5f03", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afb4f7ee-9db2-4f76-9c0f-7f8dcd903b0f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c838024-4ec0-47c0-abcd-13f29c1fc495", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8e8d7d6-4fa3-4f02-8256-79c6837e7ddc", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7afc35c2-f466-407f-9a90-6d9711dbf394", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureId\": \"FEID-00000001-0000-0000-0000-000000000001\",\n \"SubscriptionId\": \"SUB-ef84c0b5-d750-4a5a-99b1-4705089cd20c\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24368ffe-32a4-4372-bdc3-490b228bb846", "name": "Delete Feature Assignment", "request": { "name": "Delete Feature Assignment", "description": { "content": "Remove a feature assignment by its `FeatureAssignmentId`. This unlinks the feature from the associated subscription; the feature itself is not deleted.\n\n**What this does:** Returns a deletion confirmation. The subscription will no longer have access to the capability provided by this feature.\n\n**Next steps:**\n- Re-assign the feature — `POST /v1.0/subscriptions/features/assignments/add`", "type": "text/plain" }, "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "755d21f1-92ef-4611-ac5d-3eef75b34b54", "name": "Feature assignment removed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\",\n \"FeatureAssignmentStatus\": \"Deleted\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "638e78d6-aeca-47d7-b9b7-f5a863b95de2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dc198eb-bd62-472e-b70a-536767603a13", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "018cef29-d5d6-40dc-941a-179a9af4563e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afdf2eab-46c7-4309-ba89-bf29fe81b4cb", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1b4a66a-1eb8-40dc-992d-353be4cdc72d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "902efe0e-9ad1-4b37-9251-6f658397d0c4", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f552149d-9b7e-4e05-9c11-425eeded3db6", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d465da5d-6b14-40b4-8800-d7d710b33ae3", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05b98b24-01a9-407e-8de5-c4cf9f50f013", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee4eeb18-fb41-4d75-a33a-04e8124670de", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "subscriptions", "features", "assignments", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FeatureAssignmentId\": \"FAID-00000001-0000-0000-0000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d7bfaea0-36d3-4461-8548-d0d199f0af31", "name": "Voice", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9d115ee1-3173-4bb1-806a-00eb2127211e", "name": "Create Voice Route", "request": { "name": "Create Voice Route", "description": { "content": "Create a new voice route to define how inbound calls are handled for numbers assigned to it. Routes support SIP trunk termination, webhook-based IVR, forwarding, and workgroup distribution. Each route returns a unique CRID (Call Route ID) used when provisioning or updating numbers. Workgroups and Schedules can be attached to a route after creation to enable ring groups and business-hours routing.\n\n**What this does:** Returns the new route's `CallRouteId` (`CRID-`). Store this ID — it is required when provisioning numbers with voice enabled. Configure SIP trunk IPs, forwarding URLs, or workgroups after creation using the update endpoint.\n\n**Next steps:**\n- Assign the route to a number — `POST /v1.0/numbers/provision`\n- Add a workgroup — `POST /v1.0/workgroups`", "type": "text/plain" }, "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"\",\n \"RouteType\": \"\",\n \"VoiceUrl\": \"\",\n \"VoiceUrlMethod\": \"\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"\",\n \"VoicePasswordToken\": \"\",\n \"CallbackVoiceUrl\": \"\",\n \"CallbackVoiceUrlMethod\": \"\",\n \"TrunkIp1\": \"\",\n \"TrunkIp2\": \"\",\n \"TrunkPort1\": \"\",\n \"TrunkPort2\": \"\",\n \"TrunkTransport1\": \"\",\n \"TrunkTransport2\": \"\",\n \"TrunkUri1\": \"\",\n \"TrunkUri2\": \"\",\n \"TrunkEnabled1\": \"\",\n \"TrunkEnabled2\": \"\",\n \"Trunk1Priortiy\": \"\",\n \"Trunk1Weight\": \"\",\n \"Trunk2Priortiy\": \"\",\n \"Trunk2Weight\": \"\",\n \"HeaderManipulation\": \"\",\n \"EnableSipRefer\": \"\",\n \"TransferCallerId\": \"\",\n \"SymmetricRtp\": \"\",\n \"EnableTrpSecureTrunk\": \"\",\n \"EnablePstnTransfer\": \"\",\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": \"\",\n \"TerminationUriSubdomain\": \"\",\n \"EnableCallStreaming\": \"\",\n \"WssUri\": \"\",\n \"RouteEnabled\": \"\",\n \"IntelligentRouteEnabled\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f1636d4d-2c4e-42a6-b8ce-dfe24e559fc7", "name": "Success — returns the newly created Voice Route ID (CRID)", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true,\n \"RouteEnabled\": true,\n \"IpWhiteList\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fce01a6-4f07-447b-9cbc-3ea43479084d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df7ee3d2-72b9-486f-a4b8-19df91e7982b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11aa66ac-45bc-42d2-9d96-2981c2263f17", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "280c1698-884f-43f1-b562-8a41865b152a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62bbab31-8a43-43bf-b5b9-d5a19eb29cee", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c560f0ec-ef7b-47cd-acbb-50395281ea33", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17ae4ce3-3054-417a-a6c1-fecf6e97761e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "415be061-0d60-44ec-a108-718800ba9a2e", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b294751d-f7e4-4696-a87b-6eaeee02de8f", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f489e0cd-98a6-41e4-bca1-4b1e8419d67d", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"POST\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"RouteEnabled\": true,\n \"IntelligentRouteEnabled\": true,\n \"AccountId\": \"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32970dca-460c-4b11-b45b-71cd2441a8ec", "name": "Get Voice Route Details", "request": { "name": "Get Voice Route Details", "description": { "content": "Retrieve detailed configuration for a specific voice route using its CRID. Returns SIP trunk configuration, forwarding rules, IVR settings, workgroup assignments, and schedule information.\n\n**What this does:** Returns the full route configuration including route type, SIP trunk settings, webhook URLs, authentication, and workgroup associations. Use this to confirm route settings or retrieve the `CRID-` for use in provisioning.\n\n**Next steps:**\n- Update route — `POST /v1.0/voice/routes/update`\n- Provision a number using this route — `POST /v1.0/numbers/provision`", "type": "text/plain" }, "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "CallRouteID", "value": "", "description": "The unique voice route ID (e.g., CRID-xxxxx)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "65da072d-3eee-4f53-b788-39949efbb3eb", "name": "Voice Route Details", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IpWhiteList\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86de49b9-5d47-465b-9412-3744e66fa554", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "830022ae-a5fb-477e-87c2-a9716f34ee45", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9525fcdc-c8ca-452d-a380-2c5c978022ed", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8ddecfe-31ff-4c12-817c-a4f15ad90806", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb7a376e-8901-46e2-b4c1-9bffde17d6b6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c9c8894-4cb5-4097-93c6-e932b0478fd8", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f62af458-e7df-4194-98c1-338f3a39c64c", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdd61510-83e2-4b5d-95d7-811256bd6ce6", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e05e5eb-4635-40f2-bf96-333a5fadd80c", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09d20169-83a2-44b9-bd79-4ff279b490d8", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "CallRouteID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bbcda5d5-0d46-4c5c-8736-df86b00d6b3b", "name": "Update Voice Route", "request": { "name": "Update Voice Route", "description": { "content": "Update an existing voice route's configuration including SIP trunk settings, forwarding numbers, IVR menus, and workgroup assignments. Changes apply immediately to all numbers using this route.\n\n**What this does:** Returns the updated route configuration. Only fields you send are changed. Changes apply immediately to all numbers using this route.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/voice/routes`\n- View numbers using this route — `GET /v1.0/numbers/inventory`", "type": "text/plain" }, "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"\",\n \"RouteName\": \"\",\n \"RouteType\": \"\",\n \"VoiceUrl\": \"\",\n \"VoiceUrlMethod\": \"\",\n \"TrunkIp1\": \"\",\n \"TrunkIp2\": \"\",\n \"TrunkPort1\": \"\",\n \"TrunkPort2\": \"\",\n \"TrunkTransport1\": \"\",\n \"TrunkTransport2\": \"\",\n \"TrunkEnabled1\": \"\",\n \"TrunkEnabled2\": \"\",\n \"RouteEnabled\": \"\",\n \"VoiceAuthenticationType\": \"\",\n \"VoiceUsername\": \"\",\n \"VoicePasswordToken\": \"\",\n \"CallbackVoiceUrl\": \"\",\n \"CallbackVoiceUrlMethod\": \"\",\n \"TrunkUri1\": \"\",\n \"TrunkUri2\": \"\",\n \"Trunk1Priortiy\": \"\",\n \"Trunk1Weight\": \"\",\n \"Trunk2Priortiy\": \"\",\n \"Trunk2Weight\": \"\",\n \"HeaderManipulation\": \"\",\n \"EnableSipRefer\": \"\",\n \"TransferCallerId\": \"\",\n \"SymmetricRtp\": \"\",\n \"EnableTrpSecureTrunk\": \"\",\n \"EnablePstnTransfer\": \"\",\n \"IpWhitelist\": [\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n },\n {\n \"IpAddress\": {\n \"value\": \"\"\n }\n }\n ],\n \"CnamLookup\": \"\",\n \"TerminationUriSubdomain\": \"\",\n \"EnableCallStreaming\": \"\",\n \"WssUri\": \"\",\n \"IntelligentRouteEnabled\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1c4e723b-b5aa-4738-b3fa-f857591606d0", "name": "Update Voice Route", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IpWhiteList\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "150c696a-73b9-48c8-bbab-2a8ae5a11ddd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7171b7af-d021-4636-bee8-b3aac8aaa3da", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4e42be6-6bd2-4e40-a411-b6d70ec2b8d4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70407757-3cee-4115-8461-3bc22cdb357a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f361e5e1-a28f-4da0-b576-e193932211c0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e041085-33f0-4ffd-8032-f2705068ca43", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "600b9232-46af-4b14-803c-789fa424075c", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0435ff9-e66d-43fc-81b4-f96d8c8a3766", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78b510f6-37f0-4db8-8a6d-bd285df327be", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30972a3e-9b17-4520-a3ed-ed17d3ad1737", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-509de94f-79cc-429b-a317-2102654dabbb\",\n \"RouteName\": \"Main SIP Trunk\",\n \"RouteType\": \"Trunk\",\n \"VoiceUrl\": \"https://domain.com\",\n \"VoiceUrlMethod\": \"GET\",\n \"TrunkIp1\": \"20.87.87.87\",\n \"TrunkIp2\": \"20.87.87.86\",\n \"TrunkPort1\": \"5061\",\n \"TrunkPort2\": \"5060\",\n \"TrunkTransport1\": \"UDP\",\n \"TrunkTransport2\": \"TCP\",\n \"TrunkEnabled1\": true,\n \"TrunkEnabled2\": false,\n \"RouteEnabled\": true,\n \"VoiceAuthenticationType\": \"Basic\",\n \"VoiceUsername\": \"admin\",\n \"VoicePasswordToken\": \"passwordORbearerToken\",\n \"CallbackVoiceUrl\": \"https://apiendpoint.com\",\n \"CallbackVoiceUrlMethod\": \"POST\",\n \"TrunkUri1\": \"https://pstn.joonto.com\",\n \"TrunkUri2\": \"https://pstn2.joonto.com\",\n \"Trunk1Priortiy\": 10,\n \"Trunk1Weight\": 10,\n \"Trunk2Priortiy\": 20,\n \"Trunk2Weight\": 20,\n \"HeaderManipulation\": \"HMI8802029\",\n \"EnableSipRefer\": true,\n \"TransferCallerId\": \"Transferee/Transferor\",\n \"SymmetricRtp\": true,\n \"EnableTrpSecureTrunk\": true,\n \"EnablePstnTransfer\": true,\n \"IpWhitelist\": [\n {\n \"IpAddress\": \"20.20.10.10\"\n },\n {\n \"IpAddress\": \"20.20.10.20\"\n }\n ],\n \"CnamLookup\": true,\n \"TerminationUriSubdomain\": \"client\",\n \"EnableCallStreaming\": true,\n \"WssUri\": \"wss://192.67.88.2\",\n \"IntelligentRouteEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a851ac82-be17-489e-b209-ce178cd08c04", "name": "Delete Voice Route", "request": { "name": "Delete Voice Route", "description": { "content": "Permanently delete a voice route from your account. Phone numbers using this route will need to be reassigned to a different route before deletion. This action cannot be undone.\n\n**What this does:** Returns a deletion confirmation. Numbers assigned to this route will lose voice routing — reassign them to a different route before deleting to avoid service disruption.\n\n**Next steps:**\n- Create a replacement route — `POST /v1.0/voice/routes`\n- Update affected numbers — `POST /v1.0/numbers/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ad9d158a-cd42-473c-8ed1-19d8b9f07a04", "name": "Delete Voice Route", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CallRouteStatus\": \"Deleted\",\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b883df4c-65e3-49f5-b953-097400c0ea07", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a5dbca2-60c2-43bc-98f5-6f5e410bbc25", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e42646b-5d00-4057-a495-64f732e72638", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ab9e7f-cbc2-4038-b7f6-b4f2ac2abc2b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a19a911-2b4d-4641-b0f6-e84a512bf25a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "458ba74e-b5a0-4e98-9b1a-acc3992d524b", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31bab32d-832b-4c11-b8d0-9a82192c97ce", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bff5b54d-49dd-4fe5-8b6e-fa88912c8124", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40927df5-249f-4036-845d-419851324c7f", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07af77ef-d9ec-44bd-9d6b-0e6b5a5d487d", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "voice", "routes", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CallRouteId\": \"CRID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "86c7f206-3354-49fb-993a-5f62820a51b1", "name": "Workgroups", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6bb456dc-5a20-4316-a650-2f7f5ddf2718", "name": "Create Workgroup", "request": { "name": "Create Workgroup", "description": { "content": "**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Required:** Voice Route ID (CRID) — `POST /v1.0/voice/routes`\n\n---\n\nCreate a new workgroup for intelligent call routing. Workgroups support types such as IVR, simultaneous ring, and round-robin distribution. Returns a unique WorkgroupId.\n\n**What this does:** Returns the new workgroup's `WorkgroupId` (`WG-`) and full configuration. Once created, add members using `POST /v1.0/workgroups/activity` and assign the workgroup to a voice route.\n\n**Next steps:**\n- Add members — `POST /v1.0/workgroups/activity`\n- View account workgroups — `GET /v1.0/account/workgroups`", "type": "text/plain" }, "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Name\": \"\",\n \"Type\": \"\",\n \"TelegentPhone\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fbdab0c5-48dd-4143-b769-7c8ab61a6215", "name": "Success — returns the new Workgroup ID (WID-) and configuration", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"IVR Workgroup\",\n \"TelegentPhone\": \"+1234567890\",\n \"Type\": \"IVR\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"Hello, welcome to Telegent. Press 1 for Sales, Press 2 for Support.\",\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed92c316-8a0d-4c57-82fd-35925368c6dc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9754ceb2-01e7-45f8-98c8-b34e78cbc211", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "122cb82a-4530-4109-870b-86e66e6af5fd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fd43e63-8c41-4c91-8d96-9c67cc7c2c06", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99d40c7d-cc3d-4ae5-a05e-481cf8891742", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c86d7f48-82aa-4aa7-a932-0f6afc5ca961", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22ef28cc-9abd-4c8f-bddf-40481e014484", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1041972c-92cc-41a9-b4ce-663e7b699f15", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1473f3c-e216-40e2-9ee6-747668f5f863", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95d1ad62-ae96-43b5-85ed-7f314256e5cf", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"IVR Workgroup\",\n \"Type\": \"IVR\",\n \"TelegentPhone\": \"+1234567890\",\n \"CallOrder\": \"1\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"InternalExtension\": \"\",\n \"CallerIdType\": \"\",\n \"CallerIdName\": \"\",\n \"RecordCalls\": true,\n \"TranscribeRecordings\": false,\n \"ScheduleId\": \"SID-3741d220-0663-4289-85df-c203f43db5a6\",\n \"TimeZone\": \"\",\n \"HoldMusicId\": \"\",\n \"AiRecording\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"WaitBetween\": \"\",\n \"TollFreeNumber\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44c65c42-1eca-4087-b95f-928205f79634", "name": "Get Workgroup Details", "request": { "name": "Get Workgroup Details", "description": { "content": "Retrieve configuration details for a specific workgroup by its WorkgroupId. Returns the workgroup's name, type, members, schedule, and routing settings.\n\n**What this does:** Returns the full workgroup configuration including name, type, assigned phone number, schedule, timezone, hold music, off-hours forwarding rules, and member activities. Use this to audit a workgroup or retrieve the `WG-` ID for use in route configuration.\n\n**Next steps:**\n- Add a member — `POST /v1.0/workgroups/activity`\n- Update the workgroup — `POST /v1.0/workgroups/update`\n- Attach to a voice route — `POST /v1.0/voice/routes/update`", "type": "text/plain" }, "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "WorkgroupId", "value": "", "description": "The workgroup ID to retrieve details for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c79cab47-6fa0-47d4-984a-f0bde71488b2", "name": "Success — returns workgroup configuration details", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"WorkgroupId\": \"WG-abc123\",\n \"Name\": \"Support Team\",\n \"Type\": \"ring\",\n \"AccountId\": \"AID-ab12345-2725-45a1-bd5e-526ed19799xx\",\n \"Active\": true,\n \"ScheduleId\": \"SCH-abc123\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65f5d26-61a2-46f9-bac6-c027ce50cb1d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9130ec4-5e36-4059-8d9f-86d7fa340b0b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a74f3fd-8c08-410d-a4f7-a88c2798fa71", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad1d7df3-a9ee-4dc7-9d91-80a6866931d3", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce281912-4077-4328-9137-eef5188b3c14", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c35be63d-f55a-41c6-9528-5491d0e8fbcb", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb943284-f3be-4b96-a322-b21a7ef9455a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cabe672d-b2b6-4211-9050-bedd95acd412", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bfdebab-b869-4bb5-b62c-9838e4b07ec2", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7bfb9ae-9fe7-411b-827f-95b30e0d9674", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0eb01016-6202-4223-9044-ece2db8dfeb5", "name": "Update Workgroup", "request": { "name": "Update Workgroup", "description": { "content": "Update an existing workgroup configuration. Requires the WorkgroupId of the workgroup to modify.\n\n**What this does:** Returns the updated workgroup configuration. Only fields you send are changed; omitted fields retain their current values. Changes apply immediately to all calls routing through this workgroup.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/workgroups`\n- View members — `POST /v1.0/workgroups/activity`", "type": "text/plain" }, "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8e8f3a4a-e00e-4b58-ba22-f3767bf8f107", "name": "Workgroup Updated", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"Updated IVR Workgroup\",\n \"Type\": \"round-robin\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59b059e5-6b2a-4141-9348-2a3a44666c82", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c73a2db-a7b5-4268-8fd9-3ca822dc6ba7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18d19b26-56d0-4c50-9416-1814041e84f0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dac61508-651b-4e13-bad6-156274895a3e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00c9a7a5-b5f5-4921-a9ef-bfdf572e5200", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e928dd4-3d30-4e1a-b9c4-86d5931e154e", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c02b97cd-3089-421b-985f-96168e035863", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ebb00ce-ea7f-45b5-9ae7-ddb8b515e6cf", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf811ce-27ec-498a-8823-06fe3e5b3c3e", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "667c7ccd-da8f-45f6-8dcd-55e671ce971c", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Name\": \"\",\n \"TelegentPhone\": \"\",\n \"Type\": \"\",\n \"CallOrder\": \"\",\n \"AnnouncementText\": \"\",\n \"AnnouncementUrl\": \"\",\n \"ScheduleId\": \"\",\n \"TimeZone\": \"\",\n \"RecordCalls\": \"\",\n \"TranscribeRecordings\": \"\",\n \"OffHoursType\": \"\",\n \"OffHoursId\": \"\",\n \"OnHoursType\": \"\",\n \"OnHoursId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e8ac8cd-fe66-47d3-a8ad-c2efa84f5aa2", "name": "Create Workgroup Activity", "request": { "name": "Create Workgroup Activity", "description": { "content": "Add a member (user or nested workgroup) to an existing workgroup. Each activity defines how calls are distributed to that member including their position (DigitOrder) and notification preferences.\n\n**What this does:** Returns the new activity record including the `ActivityId` and member configuration. Each activity represents one member in the workgroup ring sequence. The `CallOrder` field determines ring priority.\n\n**Next steps:**\n- Update a member — `POST /v1.0/workgroups/activity/update`\n- Remove a member — `POST /v1.0/workgroups/activity/delete`\n- View the workgroup — `GET /v1.0/workgroups`", "type": "text/plain" }, "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"\",\n \"Type\": \"\",\n \"DigitOrder\": \"\",\n \"PhoneNumber\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2695a209-6210-480a-a0f2-23fe1725b06f", "name": "Workgroup Activity Created", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"WorkgroupActivityStatus\": \"Created\",\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "816e51ee-f01e-43c0-8741-9780e4415029", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cb385d9-7bf7-4131-a42e-09ef81ad8661", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f2b0d03-5b23-4eaf-9b0f-5b8ec8e8da31", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7877da0-7423-40a0-980b-fc49c6a1d645", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4b76bb3-fc76-47cd-80c3-57298b3d9399", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ddd56f6-c3b3-45a9-ae5e-3946bc90c94d", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ce7fe19-38a4-4795-8175-1bf155deeadd", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b019fee4-7817-47da-9be1-8e063565b8ef", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25116a92-d78d-4314-8d34-b206bdc88c37", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05c44ce8-a457-4992-b1f6-a4170186173b", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"Workgroup\",\n \"DigitOrder\": 1,\n \"PhoneNumber\": \"+1234567890\",\n \"ReferenceWorkgroupId\": \"WID-12345-abc-12345\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": true,\n \"EmailNotification\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab92ebba-a7f2-4a24-b0f2-fd257e9d505f", "name": "Update Workgroup Activity", "request": { "name": "Update Workgroup Activity", "description": { "content": "Update the configuration of a member within a workgroup. A workgroup activity represents an individual agent, destination, or nested workgroup within a ring group. Modify fields such as dial order (DigitOrder), forwarding number, or notification preferences. Requires the WorkgroupActivityId (WAID-) of the activity to update.\n\n**What this does:** Returns the updated activity record. Use this to change a member's ring order, SIP details, or timeout settings within the workgroup.\n\n**Next steps:**\n- Confirm the update — `GET /v1.0/workgroups`\n- Remove the member — `POST /v1.0/workgroups/activity/delete`", "type": "text/plain" }, "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"\",\n \"DigitOrder\": \"\",\n \"PhoneNumber\": \"\",\n \"WorkgroupId\": \"\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1b2f13ea-45ad-440a-849d-cd856f0a1837", "name": "Workgroup Activity Updated", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"WorkgroupActivityStatus\": \"Updated\",\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "438f967a-9d4c-43ee-91ea-45707feed43b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09fd6431-1ce6-4f1c-a7ce-6a9ec88a25c4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48e1362b-041a-4f68-af9f-443619208b3d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe2d0dcf-2737-4d95-81c9-ef4d885a892d", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df2a93e1-8384-4522-b253-e7c5e6e079fb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a94debc6-1874-403d-87b2-9971fa1d0cdd", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37f4144d-54c9-4477-baca-ddb4f0f4cb19", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9bf20ca-c580-4cc2-9505-39efa9276d8e", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05d23deb-4aa7-4e15-a846-b574898dd302", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d87d90d-ddf3-4dd9-8433-c5120c413472", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-12345-abc-123456\",\n \"DigitOrder\": 2,\n \"PhoneNumber\": \"+1234567890\",\n \"WorkgroupId\": \"WID-12345-abc-12345\",\n \"Type\": \"\",\n \"ReferenceWorkgroupId\": \"\",\n \"ReferenceUserId\": \"\",\n \"SmsNotification\": \"\",\n \"EmailNotification\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cedef03f-33b1-4748-9898-6ef090e27da6", "name": "Delete Workgroup Activity", "request": { "name": "Delete Workgroup Activity", "description": { "content": "Remove a member activity from a workgroup. The workgroup itself is not deleted.\n\n**What this does:** Returns a deletion confirmation. Removing the activity removes that member from the workgroup's ring sequence. The workgroup itself is not affected.\n\n**Next steps:**\n- View the updated workgroup — `GET /v1.0/workgroups`\n- Add a replacement member — `POST /v1.0/workgroups/activity`", "type": "text/plain" }, "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "372b2c71-dd08-4453-910e-9d0b69c5feb9", "name": "Workgroup Activity Deleted", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"WorkgroupActivityStatus\": \"Deleted\",\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e829d085-4349-4312-b22d-547e90d021cd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca78a625-5667-4922-9b92-bed321c622f9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c6ed6e7-b118-4379-b12f-c7163500d832", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3effcb98-f178-42eb-a8da-6e02e363906e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb4f77fd-0829-43c1-b1a1-4bc08cbdff2c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06a26353-b4b6-494d-be96-da47b436dd5d", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e216d758-e132-494e-91c5-bdaf1e050ffb", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f100c45e-1fae-4466-bcce-764b1b671245", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef8e1504-6f02-4475-bfc2-a82034924dc8", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ddc73b9-80c5-4d66-97cb-6fd74b04e49e", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "activity", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkgroupActivityId\": \"WAID-4dec6beb-3985-444b-8c06-8baa70dc1416\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a16d712b-fec6-4185-9c76-d4a13bbb79fd", "name": "Delete Workgroup", "request": { "name": "Delete Workgroup", "description": { "content": "Permanently remove a workgroup. Before deleting, ensure the workgroup is not assigned to any active voice routes or numbers.\n\n**What this does:** Returns a deletion confirmation. Ensure the workgroup is not assigned to any active voice routes before deleting to avoid call routing failures.\n\n**Next steps:**\n- View account workgroups — `GET /v1.0/account/workgroups`\n- Create a replacement — `POST /v1.0/workgroups`", "type": "text/plain" }, "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "WorkgroupId", "value": "", "description": "The workgroup ID to delete" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "8db35077-18e1-4b3b-aabe-a3c78dda85f8", "name": "Success — returns deletion confirmation", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"WorkgroupId\": \"WG-abc123\",\n \"Successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77f5d22f-8a91-4198-9a5a-ca4463f32f04", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5f81c85-975c-48a3-8c33-11fe1a5385fa", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b55f112c-cd4f-427e-896c-1ec3b9180a53", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72d33d3e-3ed1-4657-bf80-771c24bb3246", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "654ef52f-68ff-4f69-ae20-f70df7fc1921", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38471acd-fe19-4c7f-ba52-96b35b4b676b", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2459dc4a-52de-4106-b9fd-20e30017883f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7bad729-6d29-46b9-9ab2-b2e49a41c4c6", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0582c9aa-8833-4ad9-a7e1-86d1032473be", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "515b0a1d-9116-4975-959f-14a9302ac4c5", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "workgroups", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WorkgroupId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3ecd5b85-0d2e-48fa-a6d8-4213fb033c65", "name": "Health Status", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "17db1b7e-a4fa-4a82-8a2f-9530d1ef6042", "name": "Health Status", "request": { "name": "Health Status", "description": { "content": "Check that the Telegent platform and its upstream dependencies are reachable. Use this as a pre-flight check before a batch of provisioning calls, or as the target for an uptime monitor.\n\n**What this checks:**\n- **`Database`** — the Telegent platform database connection.\n- **`TMobile_Api`** — reachability of the upstream T-Mobile API, verified with a live available-products call.\n\nEach check reports its own `Status`, how long it took in `Duration_Ms`, and an `Error` string that is `null` while the dependency is healthy. The top-level `Status` summarises both, and `Checked_On_UTC` is the UTC timestamp the checks ran.\n\n**Reading the response:** A dependency being unreachable does not fail the request — this endpoint returns HTTP `200` and reports the problem in the payload. Always read `Status` rather than relying on the HTTP status code alone, and check each dependency's `Error` for the underlying cause.\n\n**Note on `Duration_Ms`:** these are live round-trip times against the dependency, not cached values, so a slow-but-healthy upstream shows up as a large `Duration_Ms` with `Status: \"Ok\"`.", "type": "text/plain" }, "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d512516f-c96a-4547-a13e-1b4298b79a8e", "name": "Success — returns platform and dependency health", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Status\": \"Healthy\",\n \"Checked_On_UTC\": \"2026-08-10T18:15:37.9459153Z\",\n \"Database\": {\n \"Status\": \"Ok\",\n \"Duration_Ms\": 1335,\n \"Error\": null\n },\n \"TMobile_Api\": {\n \"Status\": \"Ok\",\n \"Duration_Ms\": 2157,\n \"Error\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17aeb13a-da00-4434-a45a-078538d65f0d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4898c854-5074-4b57-8a5f-e80e03f64447", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "599bd41c-63ef-4de9-8ec9-672cf80d1fab", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2ba4df8-ed0c-427c-aa15-d746ab0fb435", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a3fafa-4612-4f5b-a2dc-5d4922f0dbf1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85564857-f9f9-4700-91e2-d2e14c2121d6", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b31fc92f-ac59-4329-b889-4d241ac43c84", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb020197-8ae3-41f2-9ca5-f36b197028ba", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f65f154e-2db2-45d3-8062-19ea7ff64bec", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29758f4f-eec8-4049-b3b9-0d3f48a0a777", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "health-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f3d8b57c-162e-4291-9e68-06622d916414", "name": "Webhooks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fca69889-d6ac-4bcb-9bf0-b017a9bed042", "name": "Get Webhook", "request": { "name": "Get Webhook", "description": { "content": "Retrieves the full configuration of a single webhook by its `WebhookId`, including the target URL, HTTP method, data format, authentication details, and subscribed events. Use this to inspect or audit an existing webhook before updating or deleting it.\n\n**What this returns:** A `Webhook_Result` object containing the `WebhookUrl`, `Method`, `DataFormat`, `AuthenticationType` and credentials, `SubscribedEvents`, and the webhook's `Active` status.\n\n**Prerequisites:**\n- **Required:** Bearer token — `POST /v1.0/oauth2/tokens`\n- **Required:** `WebhookId` from a prior `POST /v1.0/webhook` call", "type": "text/plain" }, "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "WebhookId", "value": "", "description": "WebhookId string" }, { "disabled": false, "key": "AccountId", "value": "", "description": "AccountId string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "auth": null }, "response": [ { "id": "ee022a95-859a-44a6-acff-32c9685f533d", "name": "Success", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"string\",\n \"WebhookUrl\": \"string\",\n \"Method\": \"string\",\n \"DataFormat\": \"string\",\n \"AuthenticationType\": \"string\",\n \"AuthenticationUsername\": \"string\",\n \"AuthenticationPassword\": \"string\",\n \"AuthenticationToken\": \"string\",\n \"SubscribedEvents\": \"string\",\n \"WebhookId\": \"string\",\n \"Active\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12b974e7-3164-477f-844b-84df193e87c7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c856fe2a-edf8-48f6-a94e-e7f19e0a34c0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "586d9459-8dff-4415-9b25-cc4c1d48a266", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aaa5a37-c083-4155-a803-e4e5969be8a4", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fe30b8f-5eed-4c73-afda-fabaaa339306", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "731783b1-c1fa-4d84-b7d4-e7ba327c470f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb00f631-dfec-499a-9f34-319c81319425", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41b4e3c5-b974-4332-9df6-3c4ad924cff4", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62baf67d-5462-4340-a89b-bf674050f695", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1559579a-8dad-4528-a347-bd9bfa52861f", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "WebhookId", "value": "" }, { "key": "AccountId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32059433-06ae-4404-a6cf-fcb2d975a05f", "name": "Create Webhook", "request": { "name": "Create Webhook", "description": { "content": "Register a webhook endpoint to receive event notifications from your Telegent account. Use this to subscribe to events such as order updates, message status changes, or other platform activity, with optional Basic or Token authentication for callback security.\n\n**Available subscribable events:** `Order_Update`, `New_Sms`, `Call_Completed`, `Call_On_Hold`, `Call_Recording`, `Call_In_Progress`, `Call_Ringing`", "type": "text/plain" }, "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "39d0235c-8a6a-4862-8fa9-798df6aef280", "name": "Success", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"string\",\n \"WebhookUrl\": \"string\",\n \"Method\": \"string\",\n \"DataFormat\": \"string\",\n \"AuthenticationType\": \"string\",\n \"AuthenticationUsername\": \"string\",\n \"AuthenticationPassword\": \"string\",\n \"AuthenticationToken\": \"string\",\n \"SubscribedEvents\": \"string\",\n \"WebhookId\": \"string\",\n \"Active\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60d9d14d-0db6-4a89-a208-78c92f718bac", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d896445e-c324-4eaa-b70c-3e2dc3e22a3f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9363fd3-ae02-489b-8e3e-d696e821af13", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f35f2190-560c-4807-a7d4-44556c8c6edd", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "624142ca-3535-44b6-8641-b54f512a9461", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c01f6e0-fca0-4ef4-81b8-b23cc8c290f5", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfa6a405-a8e0-4315-8c6f-05bc61ba31de", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "418124ce-7ada-469b-b1b2-ee50e96d77f1", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31f72675-2b0a-4543-9000-233350ad9671", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1eeb202-b109-4130-80ac-16887f3c1326", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a9ddb2f-bd90-4724-96eb-82d0633834d8", "name": "Update Webhook", "request": { "name": "Update Webhook", "description": { "content": "Update the configuration of an existing webhook, including its destination URL, HTTP method, authentication credentials, and the list of subscribed events. Use this to rotate credentials, change the callback endpoint, or modify which events trigger notifications without recreating the webhook.", "type": "text/plain" }, "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31a3634f-82aa-4a0c-afb7-6acc468b35a1", "name": "Success", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccountId\": \"string\",\n \"WebhookUrl\": \"string\",\n \"Method\": \"string\",\n \"DataFormat\": \"string\",\n \"AuthenticationType\": \"string\",\n \"AuthenticationUsername\": \"string\",\n \"AuthenticationPassword\": \"string\",\n \"AuthenticationToken\": \"string\",\n \"SubscribedEvents\": \"string\",\n \"WebhookId\": \"string\",\n \"Active\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41e4b6c7-6d23-4227-b2c5-22fd77efaedb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deaad53d-4dc7-45dc-91b9-4269da13cb87", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc4b358c-8fef-4ab1-bc23-85c1556b5c7d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c6fa6be-2bd8-4718-b86b-8db42692464b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0e8649f-7ab9-4556-8c5c-5eebec78832c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dab4d9ff-5869-4ed7-a254-684b3b560c9f", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0555237d-eb1d-4041-9a27-2f4ec534494d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7574da24-727f-4fed-a882-15cb072bd4e6", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8627a86-ea1b-4f67-8bfc-49c7c3284f5e", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af98d4c5-3bdd-4090-af55-a0864f2fad39", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccountId\": \"\",\n \"WebhookUrl\": \"\",\n \"Method\": \"\",\n \"DataFormat\": \"\",\n \"AuthenticationType\": \"\",\n \"AuthenticationUsername\": \"\",\n \"AuthenticationPassword\": \"\",\n \"AuthenticationToken\": \"\",\n \"SubscribedEvents\": \"\",\n \"WebhookId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c57f5d3c-f4a4-4b34-8012-791439574b91", "name": "Delete Webhook", "request": { "name": "Delete Webhook", "description": { "content": "Permanently deletes a webhook subscription, stopping all future event deliveries to its configured URL. Use this to remove webhooks that are no longer needed or to clean up obsolete event subscriptions on an account.", "type": "text/plain" }, "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aa2c32fb-1b2a-4c73-8b16-44073db69f8c", "name": "Success", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"WebhookId\": \"string\",\n \"WebhookStatus\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d41895bd-7ce2-47b4-b945-8a51368b115c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 400,\n \"Message\": \"Bad request: one or more required fields are missing or contain an invalid value.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11b6401b-a446-4ca8-8c58-e0f36f4f5a79", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 401,\n \"Message\": \"Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e79dd629-4172-4136-a1c4-32b5b94f8c40", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 403,\n \"Message\": \"Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d85d21ca-289f-42f8-a024-37cb497ec394", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 404,\n \"Message\": \"Not found: the requested resource does not exist or belongs to a different account.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccf1c896-bbd2-43e5-88f0-943d45376e06", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 405,\n \"Message\": \"Method not allowed: verify the HTTP method required for this endpoint.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6ae40f6-6c0f-484b-a9ff-5bc38c622a65", "name": "Request Timeout", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Timeout", "code": 408, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 408,\n \"Message\": \"Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df49d40b-a749-4116-b8f8-72997a1c9a8b", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 429,\n \"Message\": \"Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef42c4e6-7a85-48e2-b443-f9158fef80ea", "name": "Server Error", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 500,\n \"Message\": \"Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "328979d9-bbca-4273-bea8-c4433d0a6986", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 503,\n \"Message\": \"Service unavailable: the API is temporarily unavailable. Retry after a short delay.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb14b02-30af-4dc7-b8b4-3d282a154b63", "name": "Gateway Timeout", "originalRequest": { "url": { "path": [ "v1.0", "webhook", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WebhookId\": \"\",\n \"AccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"StatusCode\": 504,\n \"Message\": \"Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.telegent.com/v1.0", "key": "baseUrl" } ], "info": { "_postman_id": "5c6bbb57-40bf-4f03-a40d-0b8c27985cc9", "name": "mPaaS Core APIs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Telegent mPaaS (Mobile Platform as a Service) API gives you full programmatic control over mobile phone numbers, messaging, voice routing, subscribers, and account management. Use these APIs to provision MVNO and IoT numbers, send and receive SMS/MMS, configure intelligent call routing, manage subscriber accounts, and apply AI Guardian controls. All requests require a Bearer token obtained from the Authentication endpoint. For support, visit https://support.telegent.com/support/home\n\nContact Support:\n Name: Support\n Email: support@telegent.com", "type": "text/plain" } } }