Skip to content

Commit 20c84cd

Browse files
committed
[inbox] minor fixes
1 parent 189f046 commit 20c84cd

3 files changed

Lines changed: 26 additions & 10 deletions

File tree

docs/features/reading-messages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Use this to process historical messages through your existing webhook handler:
131131
}' \
132132
https://api.sms-gate.app/3rdparty/v1/inbox/refresh
133133
```
134-
3. After receiving the request, the device will send webhooks for each message in the inbox for the specified period.
134+
3. After receiving the request, the device will send webhooks with messages from the specified period.
135135

136136
## 📝 Notes
137137

docs/integration/authentication.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,14 @@ All scopes follow the pattern: `resource:action`
173173
| `messages:read` | Permission to read individual message details | Read |
174174
| `messages:list` | Permission to list and view messages | Read |
175175
| `messages:cancel` | Permission to cancel pending messages | Delete |
176-
| `messages:export` | Permission to export inbox messages | Read |
176+
177+
#### Inbox Scopes
178+
179+
| Scope | Description | Access Level |
180+
| --------------- | --------------------------------------------- | ------------ |
181+
| `inbox:list` | Permission to list and view inbox messages | Read |
182+
| `inbox:read` | Permission to read individual message details | Read |
183+
| `inbox:refresh` | Permission to refresh inbox messages | Read |
177184

178185
#### Devices Scopes
179186

@@ -217,13 +224,20 @@ All scopes follow the pattern: `resource:action`
217224

218225
#### Messages API
219226

220-
| Endpoint | Method | Required Scope | Description |
221-
| ------------------------------------ | ------ | ----------------- | ---------------------- |
222-
| `/3rdparty/v1/messages` | GET | `messages:list` | List messages |
223-
| `/3rdparty/v1/messages` | POST | `messages:send` | Send a new message |
224-
| `/3rdparty/v1/messages/:id` | GET | `messages:read` | Get message details |
225-
| `/3rdparty/v1/messages/:id` | DELETE | `messages:cancel` | Cancel pending message |
226-
| `/3rdparty/v1/messages/inbox/export` | POST | `messages:export` | Export messages |
227+
| Endpoint | Method | Required Scope | Description |
228+
| --------------------------- | ------ | ----------------- | ---------------------- |
229+
| `/3rdparty/v1/messages` | GET | `messages:list` | List messages |
230+
| `/3rdparty/v1/messages` | POST | `messages:send` | Send a new message |
231+
| `/3rdparty/v1/messages/:id` | GET | `messages:read` | Get message details |
232+
| `/3rdparty/v1/messages/:id` | DELETE | `messages:cancel` | Cancel pending message |
233+
234+
#### Inbox API
235+
236+
| Endpoint | Method | Required Scope | Description |
237+
| -------------------------------------------- | ------ | --------------- | -------------- |
238+
| `/3rdparty/v1/inbox` | GET | `inbox:list` | List inbox |
239+
| `/3rdparty/v1/inbox/refresh` | POST | `inbox:refresh` | Refresh inbox |
240+
| `/3rdparty/v1/inbox/:id/attachments/:partId` | GET | `inbox:read` | Get attachment |
227241

228242
#### Devices API
229243

docs/skill.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,9 @@ Scopes define permissions. Use the principle of least privilege:
123123
| `messages:send` | Send SMS messages |
124124
| `messages:read` | Read individual message details |
125125
| `messages:list` | List and view messages |
126-
| `messages:export` | Export inbox messages |
126+
| `inbox:list` | List incoming messages with filters |
127+
| `inbox:read` | Read incoming messages |
128+
| `inbox:refresh` | Refresh inbox messages |
127129
| `devices:list` | List registered devices |
128130
| `devices:delete` | Remove devices |
129131
| `webhooks:list` | List webhook configurations |

0 commit comments

Comments
 (0)