Chat Widget

Get Chat Widget Script

get

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/scripts/chat-widget.js

Returns the JavaScript code needed to embed the chat widget on a website

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Responses

200

JavaScript code for chat widget

application/javascript

stringOptional

JavaScript code

get

/scripts/chat-widget.js

HTTPcURLJavaScriptPython

GET /v1/scripts/chat-widget.js HTTP/1.1
Host: api.dmchamp.com
Accept: */*

200

JavaScript code for chat widget

text

Get Chat Widget Configuration

get

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/chat-widget-config

Returns the configuration for the chat widget

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Query parameters

configIdstringRequired

ID of the chat widget configuration

Responses

200

Chat widget configuration

application/json

successbooleanOptionalExample: true

dataobjectOptional

Widget configuration data

404

Configuration not found

application/json

get

/chat-widget-config

HTTPcURLJavaScriptPython

GET /v1/chat-widget-config?configId=text HTTP/1.1
Host: api.dmchamp.com
Accept: */*

{
  "success": true,
  "data": {}
}

Get Chat Widget

get

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/chat-widget/{configId}

Returns the HTML for the chat widget with the specified configuration

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Path parameters

configIdstringRequired

ID of the chat widget configuration

Responses

200

HTML content for the chat widget

text/html

stringOptional

HTML content

404

Widget not found

text/plain

get

/chat-widget/{configId}

HTTPcURLJavaScriptPython

GET /v1/chat-widget/{configId} HTTP/1.1
Host: api.dmchamp.com
Accept: */*

text

Get Chat Widget with From ID

get

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/chat-widget/{configId}/{fromId}

Returns the HTML for the chat widget with the specified configuration and from ID

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Path parameters

configIdstringRequired

ID of the chat widget configuration

fromIdstringRequired

ID of the source (for tracking purposes)

Responses

200

HTML content for the chat widget

text/html

stringOptional

HTML content

404

Widget not found

text/plain

get

/chat-widget/{configId}/{fromId}

HTTPcURLJavaScriptPython

GET /v1/chat-widget/{configId}/{fromId} HTTP/1.1
Host: api.dmchamp.com
Accept: */*

text

Handle Incoming Chat Widget Message

post

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/incoming-chat-widget-message

Processes an incoming message from the chat widget and publishes it to a PubSub topic

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Query parameters

userIdstringRequired

ID of the user/owner to whom the chat widget belongs

Body

application/json

messageTypestringRequired

Type of message (e.g., text, reaction)

Default: text

Responses

200

Message processed successfully

application/json

successbooleanOptionalExample: true

messageIdstringOptional

PubSub message ID

Example: 1234567890

400

Invalid request

application/json

405

Method not allowed

application/json

500

Server error

application/json

post

/incoming-chat-widget-message

HTTPcURLJavaScriptPython

POST /v1/incoming-chat-widget-message?userId=text HTTP/1.1
Host: api.dmchamp.com
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "customData": {
    "messageSid": "msg123",
    "fromId": "visitor123",
    "toId": "widget456",
    "body": "Hello from chat widget",
    "status": "received"
  },
  "messageType": "text"
}

Simple text messageMessage with media

{
  "success": true,
  "messageId": "1234567890"
}

Get Chat Widget Messages

get

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/chat-widget-messages

Retrieves messages for a specific chat widget conversation

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Query parameters

fromIdstringRequired

ID of the user/owner of the contact

toIdstringRequired

ID of the chat widget that the contact is using

afterstring · int64Optional

Optional timestamp (in milliseconds) to fetch only messages after this time

Responses

200

List of messages with bot typing status

application/json

isBotTypingbooleanOptional

Whether the bot is currently typing a response

400

Invalid request

application/json

404

Contact not found

application/json

500

Server error

application/json

get

/chat-widget-messages

HTTPcURLJavaScriptPython

GET /v1/chat-widget-messages?fromId=text&toId=text HTTP/1.1
Host: api.dmchamp.com
Accept: */*

{
  "messages": [
    {
      "messageSid": "msg123abc",
      "body": "Hello there, how can I help you?",
      "mediaUrl": null,
      "mediaContentType": null,
      "timestamp": "2023-05-15T14:30:45.123Z",
      "type": "text",
      "direction": "outbound",
      "status": "delivered"
    },
    {
      "messageSid": "msg456def",
      "body": "I have a question about your services",
      "mediaUrl": null,
      "mediaContentType": null,
      "timestamp": "2023-05-15T14:30:15.456Z",
      "type": "text",
      "direction": "inbound",
      "status": "delivered"
    }
  ],
  "isBotTyping": false
}

Mark Chat Widget Messages as Read

post

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/update-message-read-status

Updates the read status of all unread messages for a specific chat widget conversation

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Body

application/json

fromIdstringRequired

ID of the user/owner of the contact

toIdstringRequired

ID of the chat widget that the contact is using

Responses

200

Messages marked as read successfully

application/json

successbooleanOptionalExample: true

400

Missing required parameters

application/json

404

Contact not found

application/json

500

Server error

application/json

post

/update-message-read-status

HTTPcURLJavaScriptPython

POST /v1/update-message-read-status HTTP/1.1
Host: api.dmchamp.com
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "fromId": "user123",
  "toId": "widget456"
}

{
  "success": true
}