Calls
List calls in a chat
Read retained call history for a Chat you belong to.
GET
/
v1
/
chats
/
{chatId}
/
calls
List calls in a chat
curl --request GET \
--url https://api.relayapp.im/v1/chats/{chatId}/calls \
--header 'Authorization: Bearer <token>'{
"calls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"kind": "user"
},
"to": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"kind": "user"
}
],
"status": "ringing",
"revision": 2,
"created_at": "2023-11-07T05:31:56Z",
"ringing_at": "2023-11-07T05:31:56Z",
"answered_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}Authorizations
Bearer token authentication. Include your API token in the Authorization header.
Format: Authorization: Bearer <your-token>
Path Parameters
⌘I
List calls in a chat
curl --request GET \
--url https://api.relayapp.im/v1/chats/{chatId}/calls \
--header 'Authorization: Bearer <token>'{
"calls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"kind": "user"
},
"to": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"kind": "user"
}
],
"status": "ringing",
"revision": 2,
"created_at": "2023-11-07T05:31:56Z",
"ringing_at": "2023-11-07T05:31:56Z",
"answered_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"a2ui_errors": [
{
"part_index": 123,
"data_index": 123,
"a2ui_message": {
"version": "v0.9.1",
"error": {
"code": "VALIDATION_FAILED",
"surfaceId": "<string>",
"path": "<string>",
"message": "<string>"
}
}
}
],
"trace_id": "<string>"
}
