The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
environment |
Environment | The API environment. Default: Environment.PRODUCTION |
timeout |
int |
Timeout for API calls in seconds. Default: 0 |
enableRetries |
bool |
Whether to enable retries and backoff feature. Default: false |
numberOfRetries |
int |
The number of retries to make. Default: 0 |
retryInterval |
float |
The retry time interval between the endpoint calls. Default: 1 |
backOffFactor |
float |
Exponential backoff factor to increase interval between retries. Default: 2 |
maximumRetryWaitTime |
int |
The maximum wait time in seconds for overall retrying requests. Default: 0 |
retryOnTimeout |
bool |
Whether to retry on request timeout. Default: true |
httpStatusCodesToRetry |
array |
Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524 |
httpMethodsToRetry |
array |
Http methods to retry against. Default: 'GET', 'PUT' |
accessToken |
string |
The OAuth 2.0 Access Token to use for API requests. |
The API client can be initialized as follows:
$client = OnfonDeveloperV1Lib\OnfonDeveloperV1ClientBuilder::init()
->accessToken('AccessToken')
->environment('production')
->build();The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.
| Name | Description |
|---|---|
| getAuthenticationController() | Gets AuthenticationController |
| getBalanceSendSMSController() | Gets BalanceSendSMSController |
| getGroupController() | Gets GroupController |
| getContactsController() | Gets ContactsController |
| getSenderidController() | Gets SenderidController |
| getSMSCampaignsController() | Gets SMSCampaignsController |
| getComposeSMSController() | Gets ComposeSMSController |
| getPurchaseController() | Gets PurchaseController |