> ## Documentation Index > Fetch the complete documentation index at: https://docs.buildwithchirp.com/llms.txt > Use this file to discover all available pages before exploring further. # Playground Async API ## AsyncAPI ````yaml asyncapi.json Root id: Root title: Namespace / description: '' servers: - id: production protocol: https host: api.buildwithchirp.com bindings: [] variables: [] - id: development protocol: http host: localhost:3006 bindings: [] variables: [] address: / parameters: [] bindings: - protocol: ws version: 0.1.0 value: method: GET headers: type: object properties: connection: type: string const: Upgrade upgrade: type: string const: websocket query: type: object properties: EIO: description: The version of the protocol type: string const: '4' transport: description: The name of the transport type: string enum: - polling - websocket sid: description: The session identifier type: string required: - EIO - transport externalDocs: description: Engine.IO Protocol url: https://socket.io/docs/v4/engine-io-protocol/ schemaProperties: - name: method type: string description: GET required: false - name: headers type: object required: false properties: - name: connection type: string description: Upgrade required: false - name: upgrade type: string description: websocket required: false - name: query type: object required: false properties: - name: EIO type: string description: The version of the protocol required: true - name: transport type: string description: The name of the transport enumValues: - polling - websocket required: true - name: sid type: string description: The session identifier required: false operations: - &ref_33 id: RootSendOperationAuthResult title: authResult description: Outgoing event authResult type: send messages: - &ref_47 id: rootOutgoingAuthResult contentType: text/plain payload: - type: array prefixItems: &ref_0 - anyOf: - type: object properties: orgId: type: string appId: type: string required: - orgId - appId additionalProperties: false - type: object properties: id: type: string type: type: string enum: - TOKEN_EXPIRED - AUTH_FAILED code: type: string message: type: string timestamp: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - id - type - code - message - timestamp additionalProperties: false items: &ref_1 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: authResult headers: [] jsonPayloadSchema: type: array prefixItems: *ref_0 items: *ref_1 x-parser-schema-id: title: authResult example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingAuthResult bindings: [] extensions: &ref_4 - id: x-parser-unique-object-id value: Root - &ref_34 id: RootSendOperationValidationError title: validationError description: Outgoing event validationError type: send messages: - &ref_48 id: rootOutgoingValidationError contentType: text/plain payload: - type: array prefixItems: &ref_2 - description: name type: string - description: message type: string items: &ref_3 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: validationError headers: [] jsonPayloadSchema: type: array prefixItems: *ref_2 items: *ref_3 x-parser-schema-id: title: validationError example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingValidationError bindings: [] extensions: *ref_4 - &ref_35 id: RootSendOperationMessageReceived title: messageReceived description: Outgoing event messageReceived type: send messages: - &ref_49 id: rootOutgoingMessageReceived contentType: text/plain payload: - type: array prefixItems: &ref_5 - anyOf: - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_message direction: type: string enum: - outgoing - incoming content: type: object properties: text: type: string from: type: string to: type: string phoneNumberId: type: string required: - text additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_voice_message direction: type: string enum: - outgoing - incoming content: type: object properties: mediaId: type: string mimeType: type: string duration: type: number from: type: string to: type: string phoneNumberId: type: string required: - mediaId additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_image_message direction: type: string enum: - outgoing - incoming content: type: object properties: mediaId: type: string mimeType: type: string caption: type: string from: type: string to: type: string phoneNumberId: type: string required: - mediaId additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_sticker_message direction: type: string enum: - outgoing - incoming content: type: object properties: stickerUrl: type: string format: uri emoji: type: string from: type: string to: type: string phoneNumberId: type: string required: - stickerUrl additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false - type: object properties: id: type: string timestamp: type: number type: type: string const: sms_message direction: type: string enum: - outgoing - incoming content: type: object properties: text: type: string from: type: string to: type: string subject: type: string mediaUrls: type: array items: type: string isSystemMessage: type: boolean required: - text - from - to additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false discriminator: propertyName: type items: &ref_6 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: messageReceived headers: [] jsonPayloadSchema: type: array prefixItems: *ref_5 items: *ref_6 x-parser-schema-id: title: messageReceived example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingMessageReceived bindings: [] extensions: *ref_4 - &ref_36 id: RootSendOperationMessageHistory title: messageHistory description: Outgoing event messageHistory type: send messages: - &ref_50 id: rootOutgoingMessageHistory contentType: text/plain payload: - type: array prefixItems: &ref_7 - type: object properties: messages: type: array items: anyOf: - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_message direction: type: string enum: - outgoing - incoming content: type: object properties: text: type: string from: type: string to: type: string phoneNumberId: type: string required: - text additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_voice_message direction: type: string enum: - outgoing - incoming content: type: object properties: mediaId: type: string mimeType: type: string duration: type: number from: type: string to: type: string phoneNumberId: type: string required: - mediaId additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_image_message direction: type: string enum: - outgoing - incoming content: type: object properties: mediaId: type: string mimeType: type: string caption: type: string from: type: string to: type: string phoneNumberId: type: string required: - mediaId additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_sticker_message direction: type: string enum: - outgoing - incoming content: type: object properties: stickerUrl: type: string format: uri emoji: type: string from: type: string to: type: string phoneNumberId: type: string required: - stickerUrl additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false - type: object properties: id: type: string timestamp: type: number type: type: string const: sms_message direction: type: string enum: - outgoing - incoming content: type: object properties: text: type: string from: type: string to: type: string subject: type: string mediaUrls: type: array items: type: string isSystemMessage: type: boolean required: - text - from - to additionalProperties: false required: - id - timestamp - type - direction - content additionalProperties: false discriminator: propertyName: type totalCount: type: number required: - messages - totalCount additionalProperties: false items: &ref_8 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: messageHistory headers: [] jsonPayloadSchema: type: array prefixItems: *ref_7 items: *ref_8 x-parser-schema-id: title: messageHistory example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingMessageHistory bindings: [] extensions: *ref_4 - &ref_37 id: RootSendOperationMessageHistoryError title: messageHistoryError description: Outgoing event messageHistoryError type: send messages: - &ref_51 id: rootOutgoingMessageHistoryError contentType: text/plain payload: - type: array prefixItems: &ref_9 - type: object properties: id: type: string timestamp: type: number type: type: string const: error message: type: string code: type: string required: - id - timestamp - type - message additionalProperties: false items: &ref_10 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: messageHistoryError headers: [] jsonPayloadSchema: type: array prefixItems: *ref_9 items: *ref_10 x-parser-schema-id: title: messageHistoryError example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingMessageHistoryError bindings: [] extensions: *ref_4 - &ref_38 id: RootSendOperationEventLogged title: eventLogged description: Outgoing event eventLogged type: send messages: - &ref_52 id: rootOutgoingEventLogged contentType: text/plain payload: - type: array prefixItems: &ref_11 - type: object properties: id: type: string timestamp: type: number type: type: string const: event_log eventType: type: string enum: - Client - Server category: type: string enum: - Bridge - Application action: type: string detail: type: string duration: type: string required: - id - timestamp - type - eventType - category - action additionalProperties: false items: &ref_12 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: eventLogged headers: [] jsonPayloadSchema: type: array prefixItems: *ref_11 items: *ref_12 x-parser-schema-id: title: eventLogged example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingEventLogged bindings: [] extensions: *ref_4 - &ref_39 id: RootSendOperationTypingIndicator title: typingIndicator description: Outgoing event typingIndicator type: send messages: - &ref_53 id: rootOutgoingTypingIndicator contentType: text/plain payload: - type: array prefixItems: &ref_13 - type: object properties: id: type: string timestamp: type: number type: type: string const: typing_indicator isTyping: type: boolean required: - id - timestamp - type - isTyping additionalProperties: false items: &ref_14 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: typingIndicator headers: [] jsonPayloadSchema: type: array prefixItems: *ref_13 items: *ref_14 x-parser-schema-id: title: typingIndicator example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingTypingIndicator bindings: [] extensions: *ref_4 - &ref_40 id: RootSendOperationError title: error description: Outgoing event error type: send messages: - &ref_54 id: rootOutgoingError contentType: text/plain payload: - type: array prefixItems: &ref_15 - type: object properties: id: type: string timestamp: type: number type: type: string const: error message: type: string code: type: string required: - id - timestamp - type - message additionalProperties: false items: &ref_16 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: error headers: [] jsonPayloadSchema: type: array prefixItems: *ref_15 items: *ref_16 x-parser-schema-id: title: error example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingError bindings: [] extensions: *ref_4 - &ref_41 id: RootSendOperationConnected title: connected description: Outgoing event connected type: send messages: - &ref_55 id: rootOutgoingConnected contentType: text/plain payload: - type: array prefixItems: &ref_17 - type: object properties: id: type: string timestamp: type: number type: type: string const: event_log eventType: type: string enum: - Client - Server category: type: string enum: - Bridge - Application action: type: string detail: type: string duration: type: string required: - id - timestamp - type - eventType - category - action additionalProperties: false items: &ref_18 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: connected headers: [] jsonPayloadSchema: type: array prefixItems: *ref_17 items: *ref_18 x-parser-schema-id: title: connected example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingConnected bindings: [] extensions: *ref_4 - &ref_42 id: RootSendOperationPong title: pong description: Outgoing event pong type: send messages: - &ref_56 id: rootOutgoingPong contentType: text/plain payload: - type: array prefixItems: &ref_19 - type: object properties: id: type: string timestamp: type: number type: type: string const: event_log eventType: type: string enum: - Client - Server category: type: string enum: - Bridge - Application action: type: string detail: type: string duration: type: string required: - id - timestamp - type - eventType - category - action additionalProperties: false items: &ref_20 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: pong headers: [] jsonPayloadSchema: type: array prefixItems: *ref_19 items: *ref_20 x-parser-schema-id: title: pong example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootOutgoingPong bindings: [] extensions: *ref_4 - &ref_29 id: RootRecvOperationSendMessage title: sendMessage description: Incoming event sendMessage type: receive messages: - &ref_43 id: rootIncomingSendMessage contentType: text/plain payload: - type: array prefixItems: &ref_21 - anyOf: - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_message direction: type: string enum: - outgoing - incoming content: type: object properties: text: type: string from: type: string to: type: string phoneNumberId: type: string required: - text required: - id - timestamp - type - direction - content - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_voice_message direction: type: string enum: - outgoing - incoming content: type: object properties: mediaId: type: string mimeType: type: string duration: type: number from: type: string to: type: string phoneNumberId: type: string required: - mediaId required: - id - timestamp - type - direction - content - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_image_message direction: type: string enum: - outgoing - incoming content: type: object properties: mediaId: type: string mimeType: type: string caption: type: string from: type: string to: type: string phoneNumberId: type: string required: - mediaId required: - id - timestamp - type - direction - content - type: object properties: id: type: string timestamp: type: number type: type: string const: whatsapp_sticker_message direction: type: string enum: - outgoing - incoming content: type: object properties: stickerUrl: type: string format: uri emoji: type: string from: type: string to: type: string phoneNumberId: type: string required: - stickerUrl required: - id - timestamp - type - direction - content - type: object properties: id: type: string timestamp: type: number type: type: string const: sms_message direction: type: string enum: - outgoing - incoming content: type: object properties: text: type: string from: type: string to: type: string subject: type: string mediaUrls: type: array items: type: string isSystemMessage: type: boolean required: - text - from - to required: - id - timestamp - type - direction - content discriminator: propertyName: type items: &ref_22 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: sendMessage headers: [] jsonPayloadSchema: type: array prefixItems: *ref_21 items: *ref_22 x-parser-schema-id: title: sendMessage example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootIncomingSendMessage bindings: [] extensions: *ref_4 - &ref_30 id: RootRecvOperationRefreshAuth title: refreshAuth description: Incoming event refreshAuth type: receive messages: - &ref_44 id: rootIncomingRefreshAuth contentType: text/plain payload: - type: array prefixItems: &ref_23 - description: token type: string items: &ref_24 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: refreshAuth headers: [] jsonPayloadSchema: type: array prefixItems: *ref_23 items: *ref_24 x-parser-schema-id: title: refreshAuth example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootIncomingRefreshAuth bindings: [] extensions: *ref_4 - &ref_31 id: RootRecvOperationJoinRoom title: joinRoom description: Incoming event joinRoom type: receive messages: - &ref_45 id: rootIncomingJoinRoom contentType: text/plain payload: - type: array prefixItems: &ref_25 - type: object properties: platform: type: string enum: - whatsapp - sms from: description: >- System phone number (phoneNumberId for WhatsApp, phone number for SMS) type: string to: description: User phone number type: string required: - platform - from - to items: &ref_26 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: joinRoom headers: [] jsonPayloadSchema: type: array prefixItems: *ref_25 items: *ref_26 x-parser-schema-id: title: joinRoom example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootIncomingJoinRoom bindings: [] extensions: *ref_4 - &ref_32 id: RootRecvOperationGetMessageHistory title: getMessageHistory description: Incoming event getMessageHistory type: receive messages: - &ref_46 id: rootIncomingGetMessageHistory contentType: text/plain payload: - type: array prefixItems: &ref_27 - type: object properties: platform: type: string enum: - whatsapp - sms systemPhoneNumber: description: The system phone number type: string userPhoneNumber: description: The user phone number type: string limit: description: Maximum number of messages to return default: 100 type: number required: - platform - systemPhoneNumber - userPhoneNumber items: &ref_28 not: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: getMessageHistory headers: [] jsonPayloadSchema: type: array prefixItems: *ref_27 items: *ref_28 x-parser-schema-id: title: getMessageHistory example: '{}' bindings: [] extensions: - id: x-parser-unique-object-id value: rootIncomingGetMessageHistory bindings: [] extensions: *ref_4 sendOperations: - *ref_29 - *ref_30 - *ref_31 - *ref_32 receiveOperations: - *ref_33 - *ref_34 - *ref_35 - *ref_36 - *ref_37 - *ref_38 - *ref_39 - *ref_40 - *ref_41 - *ref_42 sendMessages: - *ref_43 - *ref_44 - *ref_45 - *ref_46 receiveMessages: - *ref_47 - *ref_48 - *ref_49 - *ref_50 - *ref_51 - *ref_52 - *ref_53 - *ref_54 - *ref_55 - *ref_56 extensions: - id: x-parser-unique-object-id value: Root securitySchemes: - id: rootSecurity0 name: Authorization type: httpApiKey description: Bearer token for authentication in: header extensions: [] ````