Properties
| Name | Type | Description |
|---|---|---|
| phoneNumber | object | This is the phone number that the message is associated with. |
| type | string | This is the type of the message. "metadata" is sent to forward metadata to the client. |
| timestamp | number | This is the timestamp of the message. |
| call | object | This is the call that the message is associated with. |
| customer | object | This is the customer that the message is associated with. |
| assistant | object | This is the assistant that the message is associated with. |
| metadata | string | This is the metadata content |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ClientMessageMetadata",
"title": "ClientMessageMetadata",
"type": "object",
"properties": {
"phoneNumber": {
"description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
"title": "ByoPhoneNumber"
},
{
"$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
"title": "TwilioPhoneNumber"
},
{
"$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
"title": "VonagePhoneNumber"
},
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
},
{
"$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
"title": "TelnyxPhoneNumber"
}
]
},
"type": {
"type": "string",
"description": "This is the type of the message. \"metadata\" is sent to forward metadata to the client.",
"enum": [
"metadata"
]
},
"timestamp": {
"type": "number",
"description": "This is the timestamp of the message."
},
"call": {
"description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
"customer": {
"description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
}
]
},
"assistant": {
"description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
}
]
},
"metadata": {
"type": "string",
"description": "This is the metadata content"
}
},
"required": [
"type",
"metadata"
]
}