Skip to main content
POST
/
api
/
call_participants
POST /api/call_participants
curl --request POST \
  --url https://api.sippet.ai/api/call_participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "attributes": {
      "call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "member_uuid": "<string>",
      "role": "caller",
      "joined_at": "<unknown>",
      "left_at": "<unknown>"
    },
    "relationships": {},
    "type": "CallParticipant"
  }
}
'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "member_uuid": "<string>",
      "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "caller",
      "joined_at": "2023-11-07T05:31:56Z",
      "left_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "call": {
        "data": {
          "id": "<string>",
          "type": "<string>",
          "meta": {}
        }
      },
      "organisation": {
        "data": {
          "id": "<string>",
          "type": "<string>",
          "meta": {}
        }
      }
    }
  },
  "included": [
    "<unknown>"
  ],
  "meta": {}
}

Authorizations

​
Authorization
string
header
required

JWT for bearer authentication

Query Parameters

​
include
string

Relationship paths to include in the response

Pattern: ^()(,())*$
​
fields
object

Limits the response fields to only those listed for each type

Example:
{
  "CallParticipant": "id,member_uuid,role,joined_at,left_at,call_id,organisation_id"
}

Body

application/vnd.api+json

Request body for the /call_participants operation on CallParticipant resource

​
data
object
required

Response

Success

​
data
object

A "Resource object" representing a CallParticipant

​
included
any[]
​
meta
object