Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: whatsapp meta params added #124

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions v2/whatsapp/send-message.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@

#### PARAMETERS

| Name | Description | type | Required |
| --------- | ----------------------------------------------------------- | ------------------- | ------------------------------ |
| channels | This block contains information related messaging channel | N/A | Yes |
| name | Name of Messaging Channel. Ex: `whatsapp` | `string` | Yes |
| from | Sender or From Number | `number` | Yes |
| recipient | This block contains contacts information related to channel | N/A | Yes |
| group_id | Segment id which contain list of phone numbers | `string` or `array` | Yes if `to` param not present |
| to | Receiver mobile numbers : `text` | `array` | Yes, if `group_id` not present |
| Name | Description | type | Required |
| --------- | ------------------------------------------------------------------------- | ------------------- | ------------------------------ |
| channels | This block contains information related messaging channel | N/A | Yes |
| name | Name of Messaging Channel. Ex: `whatsapp` | `string` | Yes |
| from | Sender or From Number | `number` | Yes |
| meta | This block contains additional information related to messaging channel | `map` | No |
| recipient | This block contains contacts information related to channel | N/A | Yes |
| foreign_id | Custom id for reference from customer. | `string` | No |
| group_id | Segment id which contain list of phone numbers | `string` or `array` | Yes if `to` param not present |
| to | Receiver mobile numbers : `text` | `array` | Yes, if `group_id` not present |

`Note` : The `recipient` block inside channel is related to particular communication channel and it is optional. The outside `recipient` channel contain common recipients for every channel.

Expand Down