Synced with docs

src/Examples/Accounts/ChargeAccount_1.php

@@ -21,8 +21,8 @@
 
 /**
  * @param array $params (See below)
- * phone_id - The phone ID list. Use the 'all' value to select all phone ids. You should specify the phones having the auto_charge=false
- * phone_number - The phone number list. Use the 'all' value to select all phone numbers. Can be used instead of phone_id. You should specify the phones having the auto_charge=false
+ * phone_id - The phone ID list separated by semicolon (;). Use the 'all' value to select all phone ids. You should specify the phones having the auto_charge=false
+ * phone_number - The phone number list separated by semicolon (;). Use the 'all' value to select all phone numbers. Can be used instead of phone_id. You should specify the phones having the auto_charge=false
  */
 $params = new ChargeAccountParams();
 

src/Examples/Accounts/ChargeAccount_2.php

@@ -21,8 +21,8 @@
 
 /**
  * @param array $params (See below)
- * phone_id - The phone ID list. Use the 'all' value to select all phone ids. You should specify the phones having the auto_charge=false
- * phone_number - The phone number list. Use the 'all' value to select all phone numbers. Can be used instead of phone_id. You should specify the phones having the auto_charge=false
+ * phone_id - The phone ID list separated by semicolon (;). Use the 'all' value to select all phone ids. You should specify the phones having the auto_charge=false
+ * phone_number - The phone number list separated by semicolon (;). Use the 'all' value to select all phone numbers. Can be used instead of phone_id. You should specify the phones having the auto_charge=false
  */
 $params = new ChargeAccountParams();
 

src/Examples/Accounts/GetAccountDocuments.php

@@ -23,10 +23,10 @@
  * @param array $params (See below)
  * with_details - Set true to view the uploaded document statuses. (The flag is ignored with the child_account_id=all)
  * verification_name - The required account verification name to filter
- * verification_status - The account verification status list. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
+ * verification_status - The account verification status list separated by semicolon (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
  * from_unverified_hold_until - Unverified subscriptions hold until the date (from ...) in format: YYYY-MM-DD
  * to_unverified_hold_until - Unverified subscriptions hold until the date (... to) in format: YYYY-MM-DD
- * child_account_id - The child account ID list. Use the 'all' value to select all child accounts
+ * child_account_id - The child account ID list separated by semicolon (;). Use the 'all' value to select all child accounts
  * children_verifications_only - Set true to get the children account verifications only
  */
 $params = new GetAccountDocumentsParams();

src/Examples/Accounts/GetAccountPlans.php

@@ -21,8 +21,8 @@
 
 /**
  * @param array $params (See below)
- * plan_type - The plan type list. The possible values are IM, MAU
- * plan_subscription_template_id - The plan ID list
+ * plan_type - The plan type list separated by semicolon (;). The possible values are IM, MAU
+ * plan_subscription_template_id - The plan ID list separated by semicolon (;)
  */
 $params = new GetAccountPlansParams();
 

src/Examples/Accounts/GetAvailablePlans.php

@@ -21,8 +21,8 @@
 
 /**
  * @param array $params (See below)
- * plan_type - The plan type list. The possible values are IM, MAU
- * plan_subscription_template_id - The plan ID list
+ * plan_type - The plan type list separated by semicolon (;). The possible values are IM, MAU
+ * plan_subscription_template_id - The plan ID list separated by semicolon (;)
  */
 $params = new GetAvailablePlansParams();
 

src/Examples/Accounts/GetChildrenAccounts_1.php

@@ -21,7 +21,7 @@
 
 /**
  * @param array $params (See below)
- * child_account_id - The account ID list. Use the 'all' value to select all accounts
+ * child_account_id - The account ID list separated by semicolon (;). Use the 'all' value to select all accounts
  * child_account_name - The child account name part to filter
  * child_account_email - The child ccount email to filter
  * active - The active flag to filter

src/Examples/Accounts/GetChildrenAccounts_2.php

@@ -21,7 +21,7 @@
 
 /**
  * @param array $params (See below)
- * child_account_id - The account ID list. Use the 'all' value to select all accounts
+ * child_account_id - The account ID list separated by semicolon (;). Use the 'all' value to select all accounts
  * child_account_name - The child account name part to filter
  * child_account_email - The child ccount email to filter
  * active - The active flag to filter

src/Examples/Accounts/GetCurrencyRate_1.php

@@ -21,7 +21,7 @@
 
 /**
  * @param array $params (See below)
- * currency - The currency code list. Examples: RUR, EUR, USD
+ * currency - The currency code list separated by semicolon (;). Examples: RUR, EUR, USD
  * date - The date, format: YYYY-MM-DD
  */
 $params = new GetCurrencyRateParams();

src/Examples/Accounts/GetCurrencyRate_2.php

@@ -21,7 +21,7 @@
 
 /**
  * @param array $params (See below)
- * currency - The currency code list. Examples: RUR, EUR, USD
+ * currency - The currency code list separated by semicolon (;). Examples: RUR, EUR, USD
  * date - The date, format: YYYY-MM-DD
  */
 $params = new GetCurrencyRateParams();

src/Examples/Accounts/GetCurrencyRate_3.php

@@ -21,7 +21,7 @@
 
 /**
  * @param array $params (See below)
- * currency - The currency code list. Examples: RUR, EUR, USD
+ * currency - The currency code list separated by semicolon (;). Examples: RUR, EUR, USD
  * date - The date, format: YYYY-MM-DD
  */
 $params = new GetCurrencyRateParams();

src/Examples/Accounts/GetResourcePrice_1.php

@@ -21,10 +21,10 @@
 
 /**
  * @param array $params (See below)
- * resource_type - The resource type list. The possible values are AUDIOHDCONFERENCE, AUDIOHDRECORD, AUDIORECORD, CALLLIST, CALLSESSION, DIALOGFLOW, IM, PSTN_IN_ALASKA, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_GEO_PH, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_INTERNATIONAL, PSTNINTEST, PSTN_IN_TF_AR, PSTN_IN_TF_AT, PSTN_IN_TF_AU, PSTN_IN_TF_BE, PSTN_IN_TF_BR, PSTN_IN_TF_CA, PSTN_IN_TF_CO, PSTN_IN_TF_CY, PSTN_IN_TF_DE, PSTN_IN_TF_DK, PSTN_IN_TF_DO, PSTN_IN_TF_FI, PSTN_IN_TF_FR, PSTN_IN_TF_GB, PSTN_IN_TF_HR, PSTN_IN_TF_HU, PSTN_IN_TF_IL, PSTN_IN_TF_LT, PSTN_IN_TF_PE, PSTN_IN_TF_US, PSTN_IN_US, PSTNOUT, PSTNOUT_EEA, PSTNOUTEMERG, PSTNOUT_KZ, PSTNOUT_LOCAL, PSTN_OUT_LOCAL_RU, RELAYED_TRAFFIC, SIPOUT, SIPOUTVIDEO, SMSINPUT, SMSOUT, SMSOUT_INTERNATIONAL, TRANSCRIPTION, TTS_TEXT_GOOGLE, TTS_YANDEX, USER_LOGON, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, VOIPIN, VOIPOUT, VOIPOUTVIDEO, YANDEXASR, ASR, ASR_GOOGLE_ENHANCED
- * price_group_id - The price group ID list
+ * resource_type - The resource type list separated by semicolon (;). The possible values are AUDIOHDCONFERENCE, AUDIOHDRECORD, AUDIORECORD, CALLLIST, CALLSESSION, DIALOGFLOW, IM, PSTN_IN_ALASKA, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_GEO_PH, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_INTERNATIONAL, PSTNINTEST, PSTN_IN_TF_AR, PSTN_IN_TF_AT, PSTN_IN_TF_AU, PSTN_IN_TF_BE, PSTN_IN_TF_BR, PSTN_IN_TF_CA, PSTN_IN_TF_CO, PSTN_IN_TF_CY, PSTN_IN_TF_DE, PSTN_IN_TF_DK, PSTN_IN_TF_DO, PSTN_IN_TF_FI, PSTN_IN_TF_FR, PSTN_IN_TF_GB, PSTN_IN_TF_HR, PSTN_IN_TF_HU, PSTN_IN_TF_IL, PSTN_IN_TF_LT, PSTN_IN_TF_PE, PSTN_IN_TF_US, PSTN_IN_US, PSTNOUT, PSTNOUT_EEA, PSTNOUTEMERG, PSTNOUT_KZ, PSTNOUT_LOCAL, PSTN_OUT_LOCAL_RU, RELAYED_TRAFFIC, SIPOUT, SIPOUTVIDEO, SMSINPUT, SMSOUT, SMSOUT_INTERNATIONAL, TRANSCRIPTION, TTS_TEXT_GOOGLE, TTS_YANDEX, USER_LOGON, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, VOIPIN, VOIPOUT, VOIPOUTVIDEO, YANDEXASR, ASR, ASR_GOOGLE_ENHANCED
+ * price_group_id - The price group ID list separated by semicolon (;)
  * price_group_name - The price group name template to filter
- * resource_param - The resource parameter list. Example: a phone number list
+ * resource_param - The resource parameter list separated by semicolon (;). Example: a phone number list
  */
 $params = new GetResourcePriceParams();
 

src/Examples/Accounts/GetResourcePrice_2.php

@@ -21,10 +21,10 @@
 
 /**
  * @param array $params (See below)
- * resource_type - The resource type list. The possible values are AUDIOHDCONFERENCE, AUDIOHDRECORD, AUDIORECORD, CALLLIST, CALLSESSION, DIALOGFLOW, IM, PSTN_IN_ALASKA, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_GEO_PH, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_INTERNATIONAL, PSTNINTEST, PSTN_IN_TF_AR, PSTN_IN_TF_AT, PSTN_IN_TF_AU, PSTN_IN_TF_BE, PSTN_IN_TF_BR, PSTN_IN_TF_CA, PSTN_IN_TF_CO, PSTN_IN_TF_CY, PSTN_IN_TF_DE, PSTN_IN_TF_DK, PSTN_IN_TF_DO, PSTN_IN_TF_FI, PSTN_IN_TF_FR, PSTN_IN_TF_GB, PSTN_IN_TF_HR, PSTN_IN_TF_HU, PSTN_IN_TF_IL, PSTN_IN_TF_LT, PSTN_IN_TF_PE, PSTN_IN_TF_US, PSTN_IN_US, PSTNOUT, PSTNOUT_EEA, PSTNOUTEMERG, PSTNOUT_KZ, PSTNOUT_LOCAL, PSTN_OUT_LOCAL_RU, RELAYED_TRAFFIC, SIPOUT, SIPOUTVIDEO, SMSINPUT, SMSOUT, SMSOUT_INTERNATIONAL, TRANSCRIPTION, TTS_TEXT_GOOGLE, TTS_YANDEX, USER_LOGON, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, VOIPIN, VOIPOUT, VOIPOUTVIDEO, YANDEXASR, ASR, ASR_GOOGLE_ENHANCED
- * price_group_id - The price group ID list
+ * resource_type - The resource type list separated by semicolon (;). The possible values are AUDIOHDCONFERENCE, AUDIOHDRECORD, AUDIORECORD, CALLLIST, CALLSESSION, DIALOGFLOW, IM, PSTN_IN_ALASKA, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_GEO_PH, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_INTERNATIONAL, PSTNINTEST, PSTN_IN_TF_AR, PSTN_IN_TF_AT, PSTN_IN_TF_AU, PSTN_IN_TF_BE, PSTN_IN_TF_BR, PSTN_IN_TF_CA, PSTN_IN_TF_CO, PSTN_IN_TF_CY, PSTN_IN_TF_DE, PSTN_IN_TF_DK, PSTN_IN_TF_DO, PSTN_IN_TF_FI, PSTN_IN_TF_FR, PSTN_IN_TF_GB, PSTN_IN_TF_HR, PSTN_IN_TF_HU, PSTN_IN_TF_IL, PSTN_IN_TF_LT, PSTN_IN_TF_PE, PSTN_IN_TF_US, PSTN_IN_US, PSTNOUT, PSTNOUT_EEA, PSTNOUTEMERG, PSTNOUT_KZ, PSTNOUT_LOCAL, PSTN_OUT_LOCAL_RU, RELAYED_TRAFFIC, SIPOUT, SIPOUTVIDEO, SMSINPUT, SMSOUT, SMSOUT_INTERNATIONAL, TRANSCRIPTION, TTS_TEXT_GOOGLE, TTS_YANDEX, USER_LOGON, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, VOIPIN, VOIPOUT, VOIPOUTVIDEO, YANDEXASR, ASR, ASR_GOOGLE_ENHANCED
+ * price_group_id - The price group ID list separated by semicolon (;)
  * price_group_name - The price group name template to filter
- * resource_param - The resource parameter list. Example: a phone number list
+ * resource_param - The resource parameter list separated by semicolon (;). Example: a phone number list
  */
 $params = new GetResourcePriceParams();
 

src/Examples/Accounts/GetResourcePrice_3.php

@@ -21,10 +21,10 @@
 
 /**
  * @param array $params (See below)
- * resource_type - The resource type list. The possible values are AUDIOHDCONFERENCE, AUDIOHDRECORD, AUDIORECORD, CALLLIST, CALLSESSION, DIALOGFLOW, IM, PSTN_IN_ALASKA, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_GEO_PH, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_INTERNATIONAL, PSTNINTEST, PSTN_IN_TF_AR, PSTN_IN_TF_AT, PSTN_IN_TF_AU, PSTN_IN_TF_BE, PSTN_IN_TF_BR, PSTN_IN_TF_CA, PSTN_IN_TF_CO, PSTN_IN_TF_CY, PSTN_IN_TF_DE, PSTN_IN_TF_DK, PSTN_IN_TF_DO, PSTN_IN_TF_FI, PSTN_IN_TF_FR, PSTN_IN_TF_GB, PSTN_IN_TF_HR, PSTN_IN_TF_HU, PSTN_IN_TF_IL, PSTN_IN_TF_LT, PSTN_IN_TF_PE, PSTN_IN_TF_US, PSTN_IN_US, PSTNOUT, PSTNOUT_EEA, PSTNOUTEMERG, PSTNOUT_KZ, PSTNOUT_LOCAL, PSTN_OUT_LOCAL_RU, RELAYED_TRAFFIC, SIPOUT, SIPOUTVIDEO, SMSINPUT, SMSOUT, SMSOUT_INTERNATIONAL, TRANSCRIPTION, TTS_TEXT_GOOGLE, TTS_YANDEX, USER_LOGON, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, VOIPIN, VOIPOUT, VOIPOUTVIDEO, YANDEXASR, ASR, ASR_GOOGLE_ENHANCED
- * price_group_id - The price group ID list
+ * resource_type - The resource type list separated by semicolon (;). The possible values are AUDIOHDCONFERENCE, AUDIOHDRECORD, AUDIORECORD, CALLLIST, CALLSESSION, DIALOGFLOW, IM, PSTN_IN_ALASKA, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_GEO_PH, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_INTERNATIONAL, PSTNINTEST, PSTN_IN_TF_AR, PSTN_IN_TF_AT, PSTN_IN_TF_AU, PSTN_IN_TF_BE, PSTN_IN_TF_BR, PSTN_IN_TF_CA, PSTN_IN_TF_CO, PSTN_IN_TF_CY, PSTN_IN_TF_DE, PSTN_IN_TF_DK, PSTN_IN_TF_DO, PSTN_IN_TF_FI, PSTN_IN_TF_FR, PSTN_IN_TF_GB, PSTN_IN_TF_HR, PSTN_IN_TF_HU, PSTN_IN_TF_IL, PSTN_IN_TF_LT, PSTN_IN_TF_PE, PSTN_IN_TF_US, PSTN_IN_US, PSTNOUT, PSTNOUT_EEA, PSTNOUTEMERG, PSTNOUT_KZ, PSTNOUT_LOCAL, PSTN_OUT_LOCAL_RU, RELAYED_TRAFFIC, SIPOUT, SIPOUTVIDEO, SMSINPUT, SMSOUT, SMSOUT_INTERNATIONAL, TRANSCRIPTION, TTS_TEXT_GOOGLE, TTS_YANDEX, USER_LOGON, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, VOIPIN, VOIPOUT, VOIPOUTVIDEO, YANDEXASR, ASR, ASR_GOOGLE_ENHANCED
+ * price_group_id - The price group ID list separated by semicolon (;)
  * price_group_name - The price group name template to filter
- * resource_param - The resource parameter list. Example: a phone number list
+ * resource_param - The resource parameter list separated by semicolon (;). Example: a phone number list
  */
 $params = new GetResourcePriceParams();
 

src/Examples/Accounts/GetSubscriptionPrice_1.php

@@ -21,7 +21,7 @@
 
 /**
  * @param array $params (See below)
- * subscription_template_id - The subscription template ID list
+ * subscription_template_id - The subscription template ID list separated by semicolon (;)
  * subscription_template_type - The subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION
  * subscription_template_name - The subscription template name  (example: SIP registration, Phone GB, Phone RU 495, ...)
  * count - The max returning record count

src/Examples/Accounts/GetSubscriptionPrice_2.php

@@ -21,7 +21,7 @@
 
 /**
  * @param array $params (See below)
- * subscription_template_id - The subscription template ID list
+ * subscription_template_id - The subscription template ID list separated by semicolon (;)
  * subscription_template_type - The subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION
  * subscription_template_name - The subscription template name  (example: SIP registration, Phone GB, Phone RU 495, ...)
  * count - The max returning record count

src/Examples/Accounts/SetAccountInfo_1.php

@@ -41,6 +41,8 @@
  * account_custom_data - The custom data
  * callback_url - If URL is specified, Voximplant cloud will make HTTP POST requests to it when something happens. For a full list of reasons see the type field of the [AccountCallback] structure. The HTTP request will have a JSON-encoded body that conforms to the [AccountCallbacks] structure
  * callback_salt - If salt string is specified, each HTTP request made by the Voximplant cloud toward the callback_url will have a salt field set to MD5 hash of account information and salt. That hash can be used be a developer to ensure that HTTP request is made by the Voximplant cloud
+ * store_outbound_sms - Set to true to store outbound message texts. Default value is false
+ * store_inbound_sms - Set to true to store inbound message texts. Default value is false
  */
 $params = new SetAccountInfoParams();
 

src/Examples/Accounts/SetAccountInfo_2.php

@@ -41,6 +41,8 @@
  * account_custom_data - The custom data
  * callback_url - If URL is specified, Voximplant cloud will make HTTP POST requests to it when something happens. For a full list of reasons see the type field of the [AccountCallback] structure. The HTTP request will have a JSON-encoded body that conforms to the [AccountCallbacks] structure
  * callback_salt - If salt string is specified, each HTTP request made by the Voximplant cloud toward the callback_url will have a salt field set to MD5 hash of account information and salt. That hash can be used be a developer to ensure that HTTP request is made by the Voximplant cloud
+ * store_outbound_sms - Set to true to store outbound message texts. Default value is false
+ * store_inbound_sms - Set to true to store inbound message texts. Default value is false
  */
 $params = new SetAccountInfoParams();
 

src/Examples/Accounts/SetAccountInfo_3.php

@@ -41,6 +41,8 @@
  * account_custom_data - The custom data
  * callback_url - If URL is specified, Voximplant cloud will make HTTP POST requests to it when something happens. For a full list of reasons see the type field of the [AccountCallback] structure. The HTTP request will have a JSON-encoded body that conforms to the [AccountCallbacks] structure
  * callback_salt - If salt string is specified, each HTTP request made by the Voximplant cloud toward the callback_url will have a salt field set to MD5 hash of account information and salt. That hash can be used be a developer to ensure that HTTP request is made by the Voximplant cloud
+ * store_outbound_sms - Set to true to store outbound message texts. Default value is false
+ * store_inbound_sms - Set to true to store inbound message texts. Default value is false
  */
 $params = new SetAccountInfoParams();
 

src/Examples/Accounts/SetAccountInfo_4.php

@@ -41,6 +41,8 @@
  * account_custom_data - The custom data
  * callback_url - If URL is specified, Voximplant cloud will make HTTP POST requests to it when something happens. For a full list of reasons see the type field of the [AccountCallback] structure. The HTTP request will have a JSON-encoded body that conforms to the [AccountCallbacks] structure
  * callback_salt - If salt string is specified, each HTTP request made by the Voximplant cloud toward the callback_url will have a salt field set to MD5 hash of account information and salt. That hash can be used be a developer to ensure that HTTP request is made by the Voximplant cloud
+ * store_outbound_sms - Set to true to store outbound message texts. Default value is false
+ * store_inbound_sms - Set to true to store inbound message texts. Default value is false
  */
 $params = new SetAccountInfoParams();
 

src/Examples/Accounts/SetChildAccountInfo.php

@@ -21,9 +21,9 @@
 
 /**
  * @param array $params (See below)
- * child_account_id - The child account ID list. Use the 'all' value to select all child accounts
- * child_account_name - The child account name list. Can be used instead of child_account_id
- * child_account_email - The child account email list. Can be used instead of child_account_id
+ * child_account_id - The child account ID list separated by semicolon (;). Use the 'all' value to select all child accounts
+ * child_account_name - The child account name list separated by semicolon (;). Can be used instead of child_account_id
+ * child_account_email - The child account email list separated by semicolon (;). Can be used instead of child_account_id
  * new_child_account_email - The new child account email
  * new_child_account_password - The new child account password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character
  * account_notifications - Voximplant notifications are required

src/Examples/AdminRoles/AddAdminRole.php

@@ -23,10 +23,10 @@
  * @param array $params (See below)
  * admin_role_name - The admin role name. The length must be less than 50
  * admin_role_active - The admin role enable flag. If false the allowed and denied entries have no affect
- * like_admin_role_id - The admin role ID list. Use the 'all' value to select all admin roles. The list specifies the roles from which the new role automatically copies all permissions (allowed_entries and denied_entries)
+ * like_admin_role_id - The admin role ID list separated by semicolon (;). Use the 'all' value to select all admin roles. The list specifies the roles from which the new role automatically copies all permissions (allowed_entries and denied_entries)
  * like_admin_role_name - The admin role name that can be used instead of like_admin_role_id. The name specifies a role from which the new role automatically copies all permissions (allowed_entries and denied_entries)
- * allowed_entries - The list of allowed access entries (the API function names)
- * denied_entries - The list of denied access entries (the API function names)
+ * allowed_entries - The list of allowed access entries separated by semicolon (;) (the API function names)
+ * denied_entries - The list of denied access entries separated by semicolon (;) (the API function names)
  */
 $params = new AddAdminRoleParams();
 

src/Examples/AdminRoles/DelAdminRole.php

@@ -21,7 +21,7 @@
 
 /**
  * @param array $params (See below)
- * admin_role_id - The admin role ID list. Use the 'all' value to select all admin roles
+ * admin_role_id - The admin role ID list separated by semicolon (;). Use the 'all' value to select all admin roles
  * admin_role_name - The admin role name to delete, can be used instead of admin_role_id
  */
 $params = new DelAdminRoleParams();