Skip to content

Commit

Permalink
[faq] add some Q&A regarding reading messages
Browse files Browse the repository at this point in the history
  • Loading branch information
capcom6 committed Jan 9, 2025
1 parent 2b4e0a0 commit be8daa8
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/faq/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ See also issue [#17](https://github.com/capcom6/android-sms-gateway/issues/17).

## How do I enable or disable delivery reports for messages?

As of version [1.3.0](https://github.com/capcom6/android-sms-gateway/releases/tag/v1.3.0), you have the option to enable or disable delivery reports for each message. By default, the delivery report feature is turned on. If you prefer not to receive delivery reports, you can disable them by setting the `withDeliveryReport` field to `false` in the JSON body of your message request. Here is an example of how to send a message without requesting a delivery report:
As of version 1.3.0, you have the option to enable or disable delivery reports for each message. By default, the delivery report feature is turned on. If you prefer not to receive delivery reports, you can disable them by setting the `withDeliveryReport` field to `false` in the JSON body of your message request. Here is an example of how to send a message without requesting a delivery report:

```json
{
Expand All @@ -43,7 +43,7 @@ As of version [1.3.0](https://github.com/capcom6/android-sms-gateway/releases/ta

## Can I use long or non-standard phone numbers?

Yes, starting from [1.6.1](https://github.com/capcom6/android-sms-gateway/releases/tag/v1.6.1) of the app, our system allows the use of long or non-standard phone numbers, which may be common with M2M (machine-to-machine) SIM cards or other special cases. To bypass the standard phone number validation, simply add the query parameter `skipPhoneValidation=true` to your API request. Please note that with validation disabled, you are responsible for ensuring the correctness of the phone numbers. They should still follow the E.164 format, beginning with a '+' and containing only digits.
Yes, starting from 1.6.1 of the app, our system allows the use of long or non-standard phone numbers, which may be common with M2M (machine-to-machine) SIM cards or other special cases. To bypass the standard phone number validation, simply add the query parameter `skipPhoneValidation=true` to your API request. Please note that with validation disabled, you are responsible for ensuring the correctness of the phone numbers. They should still follow the E.164 format, beginning with a '+' and containing only digits.

## How can I avoid mobile operator restrictions?

Expand Down
16 changes: 16 additions & 0 deletions docs/faq/reading-messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# FAQ - Reading Messages

The main article about reading messages is located [here](../features/reading-messages.md).

## Can I get incoming messages?

Yes, you can get incoming messages asynchronously via the `sms:received` webhook in two ways:

1. Any new incoming message will trigger the `sms:received` webhook by default.
2. For retrieving previously received messages, the `POST /messages/inbox/export` request can be used.

## Can I use a `GET` request to read messages?

No, synchronous reading of messages is not supported due to privacy policy.

One of the goals of the app is to maintain the same API for any mode. To implement this kind of endpoint in Cloud mode, the application would need to upload all messages from the device to the server. However, storing all of the messages of all users on the server is not secure with the current app design. We're working on additional security measures that will allow this type of access to the messages with a sufficient privacy level, but there is no timeline for this feature.
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@ nav:
- Encryption: privacy/encryption.md
- FAQ:
- General: faq/general.md
- Errors: faq/errors.md
- Webhooks: faq/webhooks.md
- Reading Messages: faq/reading-messages.md
- Errors: faq/errors.md
- Resources:
- Examples: resources/examples.md
- Third-Party: resources/3rdparty.md
Expand Down

0 comments on commit be8daa8

Please sign in to comment.