Get a call by ID

Get a call by its unique identifier.

GET /v1/calls/{callId}

Get a call by ID

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/v1/calls/{callId} \
  --header 'Authorization: <api-key>'

200

{
  "data": {
    "answeredAt": "2022-01-01T00:00:00Z",
    "answeredBy": "USlHhXmRMz",
    "initiatedBy": "USlHhXmRMz",
    "direction": "incoming",
    "status": "completed",
    "completedAt": "2022-01-01T00:00:00Z",
    "createdAt": "2022-01-01T00:00:00Z",
    "callRoute": "phone-number",
    "duration": 60,
    "forwardedFrom": "US123abc",
    "forwardedTo": "US123abc",
    "aiHandled": "ai-agent",
    "id": "AC123abc",
    "phoneNumberId": "PN123abc",
    "participants": [
      "[phone]"
    ],
    "updatedAt": "2022-01-01T00:00:00Z",
    "userId": "US123abc"
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Path Parameters

callId · string · required

Unique identifier of the call.

Pattern: ^AC(.*)$

Example:

"AC3700e624eca547eb9f749a06f2eb1"

Response

200

application/json

OK

data · object · required

Show child attributes