Calls
End a call
Either Contact ends the Call. A ringing Call ends canceled when its caller ends it and no-answer when its recipient does; an answered Call ends completed. A participant may also send end over its authenticated Call room. Cleanup remains available after a block or removal. Repeated terminal actions never restart the Call.
POST
/
v1
/
calls
/
{callId}
/
end
End a call
curl --request POST \
--url https://api.relayapp.im/v1/calls/{callId}/end \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"call": {
"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"
}
}{
"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
Body
application/json
The body is of type object.
Response
Operation completed.
Show child attributes
Show child attributes
⌘I
End a call
curl --request POST \
--url https://api.relayapp.im/v1/calls/{callId}/end \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"call": {
"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"
}
}{
"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>"
}