Chore/update readme#143
Open
marcos-sinch wants to merge 3 commits into
Open
Conversation
marcos-sinch
requested review from
Hurus111,
JPPortier,
asein-sinch,
edu-sinch and
matsk-sinch
as code owners
asein-sinch
reviewed
May 25, 2026
| #### SMS API | ||
| For the SMS API in **Australia (AU)**, **Brazil (BR)**, **Canada (CA)**, **the United States (US)**, | ||
| and **the European Union (EU)**, provide the following parameters: | ||
| #### Project auth |
Contributor
There was a problem hiding this comment.
For project-based authentication, we have 3 kinds of APIs:
- conversation API with its own regionalization (US / EU / BR) for regulatory purposes
- SMS API (US / EU / BR)
- all the others APIs, not regionalized
And on top of that, we have the service plan Id auth for SMS with additional regions
=> I'd like to see this clearly stated in the README
- SMS => 2 parts: one with project auth, explaining the OAuth2 exchange, another one with servicePlanId (legacy) with a bearer token that never expires. The region MUST be set and there are different ranges of regions depending on the auth method (because ZAP is available on US/ EU / BR)
- Conversation: The region MUST be set (US/ EU / BR) and when integrating with SMS, the regions MUST be the same
- The rest of the APIs, which are not regionalized and don't need extra parameters than projectId / accessKeyId and accessKeySecret
| project_id="some_project", | ||
| transport=MyHTTPImplementation | ||
| ) | ||
| sinch_client.configuration.transport = MyHTTPImplementation(sinch_client) |
Contributor
There was a problem hiding this comment.
Good catch!
Can you add an example of implementation of MyHTTPImplementation with a custom proxy and authentication, and also another HTTP library: httpx?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixed the custom HTTP transport example: transport is now assigned via sinch_client.configuration.transport after initialization, not passed to the constructor
Reorganized client initialization section: replaced the "SMS API" / "All Other APIs" split with a clearer Project auth (primary method) and SMS token auth (alternative, SMS-only) structure