Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mimamch committed Jun 16, 2023
1 parent c07a669 commit 2c6aa0d
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ Start the server
npm run start
```

| Parameter | Type | Description |
| :-------- | :-------- | :------------------------------------- |
| `session` | `string` | **Required**. Create Your Session Name |
| `scan` | `boolean` | Print QR at Browser |

## API Reference

#### Add new session
Expand All @@ -56,31 +61,31 @@ Start the server
| Parameter | Type | Description |
| :-------- | :-------- | :------------------------------------- |
| `session` | `string` | **Required**. Create Your Session Name |
| `scan` | `boolean` | **Optional**. Print QR at Browser |
| `scan` | `boolean` | Print QR at Browser |

#### Send Text Message

```
POST /send-message
```

| Body | Type | Description |
| :-------- | :------- | :------------------------------------------ |
| `session` | `string` | **Required**. Session Name You Have Created |
| `to` | `string` | **Required**. Receiver Phone Number |
| `text` | `string` | **Required**. Text Message |
| Body | Type | Description |
| :-------- | :------- | :----------------------------------------------------------------------- |
| `session` | `string` | **Required**. Session Name You Have Created |
| `to` | `string` | **Required**. Receiver Phone Number with Country Code (e.g: 62812345678) |
| `text` | `string` | **Required**. Text Message |

#### Send Bulk Message

```
POST /send-bulk-message
```

| Body | Type | Description |
| :-------- | :------- | :---------------------------------------------------------------- |
| `session` | `string` | **Required**. Session Name You Have Created |
| `data` | `array` | **Required**. Array Of Object Message Data |
| `delay` | `number` | **Optional**. Delay Per-message in Miliseconds, Default to 5000ms |
| Body | Type | Description |
| :-------- | :------- | :-------------------------------------------------- |
| `session` | `string` | **Required**. Session Name You Have Created |
| `data` | `array` | **Required**. Array Of Object Message Data |
| `delay` | `number` | Delay Per-message in Miliseconds, Default to 5000ms |

#### Delete session

Expand Down

0 comments on commit 2c6aa0d

Please sign in to comment.