Send a voice memo to a chat

POST

chats

{chatId}

voicememo

curl --request POST \
  --url https://api.relayapp.im/v1/chats/{chatId}/voicememo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "voice_memo_url": "<string>",
  "attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "voice_memo": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "from": "<string>",
    "to": [
      "<string>"
    ],
    "status": "<string>",
    "voice_memo": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "filename": "<string>",
      "mime_type": "<string>",
      "size_bytes": 123,
      "duration_ms": 1,
      "width": 2,
      "height": 2
    },
    "created_at": "2023-11-07T05:31:56Z",
    "chat": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "handles": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "handle": "<string>",
          "joined_at": "2023-11-07T05:31:56Z",
          "kind": "user",
          "display_name": "<string>",
          "image_url": "<string>",
          "image_color": "<string>",
          "about": "<string>",
          "verified": true,
          "is_contact": true,
          "status": "active",
          "left_at": "2023-11-07T05:31:56Z",
          "is_me": true
        }
      ],
      "is_group": true
    }
  }
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Include your API token in the Authorization header.

Format: Authorization: Bearer <your-token>

Path Parameters

chatId

string<uuid>

required

Unique identifier of the chat

Body

application/json

Option 1
Option 2

Request to send a voice memo to a chat (chat_id provided in path). Exactly one of voice_memo_url or attachment_id must be provided.

voice_memo_url

string<uri>

required

URL of the voice memo audio file. Must be a publicly accessible HTTPS URL.

Either voice_memo_url or attachment_id must be provided, but not both.

attachment_id

string<uuid>

Reference to a voice memo file pre-uploaded via POST /v1/attachments. The file is already stored, so sends using this ID skip the download step.

Either voice_memo_url or attachment_id must be provided, but not both.

Response

Voice memo accepted for delivery

Response for sending a voice memo to a chat

voice_memo

object

required

Show child attributes

Send a voice memo to a chat

curl --request POST \
  --url https://api.relayapp.im/v1/chats/{chatId}/voicememo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "voice_memo_url": "<string>",
  "attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "voice_memo": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "from": "<string>",
    "to": [
      "<string>"
    ],
    "status": "<string>",
    "voice_memo": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "filename": "<string>",
      "mime_type": "<string>",
      "size_bytes": 123,
      "duration_ms": 1,
      "width": 2,
      "height": 2
    },
    "created_at": "2023-11-07T05:31:56Z",
    "chat": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "handles": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "handle": "<string>",
          "joined_at": "2023-11-07T05:31:56Z",
          "kind": "user",
          "display_name": "<string>",
          "image_url": "<string>",
          "image_color": "<string>",
          "about": "<string>",
          "verified": true,
          "is_contact": true,
          "status": "active",
          "left_at": "2023-11-07T05:31:56Z",
          "is_me": true
        }
      ],
      "is_group": true
    }
  }
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

Overview

Chats

Messages

Attachments

Contacts

Webhooks

WebSocket

Agents

Send a voice memo to a chat

Authorizations

Path Parameters

Body

Response