Sign in

v1

latestOpenAPI 3.0.02026-07-14235231.7 KB
leg

List legs

get/legs

Response

List Legs Successfully

countnumber required

The total number of records returned by your request.

page_sizenumber required

The amount of records returned in this response

record_indexnumber required

Return page_size amount of conversations from this index in the response. That is, if your request returns 300 conversations, set record_index to 5 in order to return conversations 50 to 59. The default value is 0. That is, the first page_size calls.

Example response

{
  "_embedded": {
    "legs": [
      {
        "_links": {
          "self": {
            "href": "https://api.nexmo.com/v0.1/legs/2a71f8a1-b6f1-42b3-9eef-c69729e17513"
          }
        },
        "conversation_uuid": "CON-511d076b-9d39-498c-baa7-b7a4bfbd6e32",
        "end_time": "",
        "from": {
          "type": "app"
        },
        "rtc": {
          "session_id": "SES-84ebef0d-321a-47e6-8446-f4fcc5ca74b9",
          "state": "terminated"
        },
        "start_time": "",
        "status": "completed",
        "to": {
          "type": "app"
        },
        "type": "app",
        "uuid": "2a71f8a1-b6f1-42b3-9eef-c69729e17513"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.nexmo.com/v0.1/legs"
    }
  },
  "count": 1,
  "page_size": 10,
  "record_index": 0
}