Start a chat intro - Sudonum API

Initiate a Chat Intro by providing the reference_id and enquirer's details.

This endpoint is useful whenever you want to invoke a invoke a Chat Intro with the enquirer's details.

It is important to note here, that the reply message will not be honor however the aparty_notify_components will be used. Since the first message to the enquirer must be a template the Chat Intro needs to be setup with the aparty_notifiy_components object.

Once aparty_notifiy_components is set on Chat Intro you will receive a APARTY_NOTIFICATION webhook ahead of your BPARTY_NOTIFY webhook.

See example payloads

OK - Basic payload to invoke a Chat Intro

Extra variable data + Meta - Provide the extra_variable_data object or meta object to override existing values or add to the objects.

Delay notify to Bparty - this endpoint provides the opportunity to delay the notify messages to the bparty. This is useful when you need a delay for the aparty to become aware of the messages they would be receiving.

Request

Path Params

Body Params application/json

Example

{
    "enquirer": {
        "enquirer_name": "Joe Doe",
        "enquirer_phone_number": "2780000000"
        // OR "enquirer_email_address": "john@doe.com"
    },
    "listing": {
        "url": "www.link.to.listing",
        "reference_id": "REF-0001"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "uuid": "cbab6a46-6775-4b81-8abf-00e9cac89be5",
    "data": {
        "enquirer": {
            "enquirer_name": "Joe Doe",
            "enquirer_phone_number": "2780000000"
        },
        "listing": {
            "url": "www.link.to.listing",
            "reference_id": "REF-0001"
        }
    },
    "whatsapp_number": "2780000000 - org",
    "created": "2024-04-22T14:06:02.236573Z"
}