Skip to content

Commit

Permalink
Merge pull request #124 from midhun-mobtexting/M0-5527-incorporate-wh…
Browse files Browse the repository at this point in the history
…atsapp-metadata-in

feat: whatsapp meta params added
  • Loading branch information
sankarsuda authored Jan 23, 2024
2 parents 2daa4b7 + a7d18b1 commit eb47770
Showing 1 changed file with 10 additions and 8 deletions.
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

0 comments on commit eb47770

Please sign in to comment.