Skip to main content
All Plivo API endpoints return a response in JSON format. An api_id in each response uniquely identifies each request.

​
Response Format

Every API response includes:
  • api_id: Unique identifier for the request
  • Resource data or error details
  • HTTP status code

​
Success Response

{
  "api_id": "db342550-7f1d-11e1-8ea7-1231380bc196",
  "message": "message(s) queued",
  "message_uuid": ["db3ce55a-7f1d-11e1-8ea7-1231380bc196"]
}

​
HTTP Status Codes

CodeDescription
200Request has been executed successfully
201Resource created
202Resource changed
204Resource deleted
400A parameter is missing or is invalid
401Authentication failed
404Resource cannot be found
405HTTP method is not allowed
429Rate limit exceeded - too many requests
500Server error

​
Error Responses

When a request fails, the response includes an error object:

​
Error Response Example

{
  "api_id": "97ceeb52-58b6-11e1-86da-77300b68f8bb",
  "error": "not found"
}

​
Common Errors

StatusErrorDescription
400invalid_parameterA required parameter is missing or has an invalid value
401authentication_failedInvalid Auth ID or Auth Token
404not_foundThe requested resource does not exist
429rate_limit_exceededToo many requests in a given time period

​
Pagination Response

List endpoints return paginated responses with metadata:

​
Paginated Response Example

{
  "api_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "meta": {
    "limit": 20,
    "next": "/v1/Account/{auth_id}/Message/?limit=20&offset=20",
    "offset": 0,
    "previous": null,
    "total_count": 45
  },
  "objects": [
    {
      "message_uuid": "...",
      "...": "..."
    }
  ]
}

​
Meta Fields

FieldDescription
limitNumber of results per page
offsetNumber of records skipped
total_countTotal number of matching records
nextURL for the next page of results (null if no more)
previousURL for the previous page of results (null if first page)