Skip to content

Commit 0a18472

Browse files
Merge pull request #28 from telstra/feature/v3
update README
2 parents b56cc11 + 606d9d3 commit 0a18472

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

Diff for: README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -508,8 +508,10 @@ following arguments:
508508
- `startTime`: Use ISO format, e.g. "2024-01-24T15:39:00Z".
509509
- `endTime`: Use ISO format, e.g. "2024-01-24T16:39:00Z".
510510
- `reverse`: If set to Ture the results will be returned in reverse order.
511+
By default value False, the results will be returned in the order they were sent/received.
511512
- `direction`: Filter your messages by direction: outgoing or incoming.
512-
- `status`: Filter your messages by status.
513+
- `status`: Filter your messages by status. Available values : queued, sent, delivered,
514+
expired
513515

514516
Raises `telstra.messaging.exceptions.MessageError` if anything goes wrong.
515517

@@ -525,7 +527,9 @@ For example:
525527
# Get all messages
526528
from telstra.messaging import message
527529

528-
reply = message.get_all(limit=5,offset=0,filter="Python,SDK")
530+
reply =message.get_all(limit=5,offset=0,filter="Python,SDK",
531+
status="undeliverable",startTime="2024-08-01T17:39:36.113Z",endTime="2024-08-18T17:39:36.113Z",
532+
reverse = True, direction="outgoing")
529533
print(reply)
530534
```
531535

0 commit comments

Comments
 (0)