Crate voip_ms

Expand description

Async client for the VoIP.ms REST API.

§Quick start

use voip_ms::{Client, GetBalanceParams, GetBalanceResponse};

let client = Client::new("you@example.com", "your-api-password");
let balance: GetBalanceResponse = client
    .get_balance(&GetBalanceParams { advanced: Some(true) })
    .await?;
println!("{balance:#?}");

§Design

Every VoIP.ms API method gets a typed *Params request struct (with all fields wrapped in Option and skipped when None) and a method on Client. The default method deserializes into a generated *Response struct; each generated method also has a *_raw variant that returns serde_json::Value. The crate ships a generated *Response struct per method (e.g. GetBalanceResponse, GetDIDsInfoResponse) inferred from the official API documentation’s example output, so default calls can deserialize into a known shape without callers writing their own structs.

§Authentication

VoIP.ms uses an api_username (your account email) and an api_password that is distinct from your portal password — generate it under the “SOAP and REST/JSON API” page in the customer portal and enable API access there.

§IP allow-listing

By default no IP address may consume the VoIP.ms API. Under “Main Menu” → “SOAP & REST/JSON API” in the portal, add the IP address(es) you’ll call from and save. The portal accepts individual addresses, CIDR ranges, wildcard forms (192.168.1.*), and DNS names. The sole exception is getIP (Client::get_ip), which works without an allow-listed IP so you can discover the address to add.

§Wire format

All calls are HTTP GET against the REST endpoint (DEFAULT_BASE_URL, …/api/v1/rest.php) with parameters in the query string. That endpoint returns the { "status": ... } JSON envelope directly, which this crate deserializes – a status other than success surfaces as Error::Api, except an empty-collection status (ApiStatus::is_empty, e.g. no_sms), which the typed methods return as an empty response (the *_raw methods still surface it verbatim). (The generic …/api/v1/ endpoint instead defaults to text/html and needs an explicit content_type=json; this crate does not use it.)

Re-exports§

pub use chrono;
pub use chrono_tz;
pub use reqwest;
pub use rust_decimal;
pub use serde_json;

Structs§

AddChargeParams: - Adds a Charge to a specific Reseller Client
AddChargeResponse: Response body for Client::add_charge (wire method addCharge).
AddLNPFileParams: - Add an invoice file to a portability process.
AddLNPFileResponse: Response body for Client::add_lnp_file (wire method addLNPFile).
AddLNPPortParams: - Add one or more numbers to start a portability process.
AddLNPPortResponse: Response body for Client::add_lnp_port (wire method addLNPPort).
AddMemberToConferenceParams: - Add Member to a Conference
AddMemberToConferenceResponse: Response body for Client::add_member_to_conference (wire method addMemberToConference).
AddPaymentParams: - Adds a Payment to a specific Reseller Client
AddPaymentResponse: Response body for Client::add_payment (wire method addPayment).
AssignDIDvPRIParams: - Assigns a Per Minute DID to a VPRI (Flat Rate DIDs can’t be assigned)
AssignDIDvPRIResponse: Response body for Client::assign_did_vpri (wire method assignDIDvPRI).
BackOrderDIDCANParams: - Backorder DID (CANADA) from a specific ratecenter and province.
BackOrderDIDCANResponse: Response body for Client::back_order_did_can (wire method backOrderDIDCAN).
BackOrderDIDUSAParams: - Backorder DID (USA) from a specific ratecenter and state.
BackOrderDIDUSAResponse: Response body for Client::back_order_did_usa (wire method backOrderDIDUSA).
CancelDIDParams: - Deletes a specific DID from your Account.
CancelDIDResponse: Response body for Client::cancel_did (wire method cancelDID).
CancelFAXNumberParams: - Deletes a specific Fax Number from your Account.
CancelFAXNumberResponse: Response body for Client::cancel_fax_number (wire method cancelFaxNumber).
Client: Async client for the VoIP.ms REST API.
ClientBuilder: Builder for Client.
ConnectDIDParams: - Connects a specific DID to a specific Reseller Client Sub Account
ConnectDIDResponse: Response body for Client::connect_did (wire method connectDID).
ConnectFAXParams: - Connects a specific FAX DID to a specific Reseller Client Sub Account
ConnectFAXResponse: Response body for Client::connect_fax (wire method connectFAX).
CreateSubAccountParams: - Adds a new Sub Account entry to your Account
CreateSubAccountResponse: Response body for Client::create_sub_account (wire method createSubAccount).
CreateVoicemailParams: - Adds a new Voicemail entry to your Account
CreateVoicemailResponse: Response body for Client::create_voicemail (wire method createVoicemail).
DelCallHuntingParams: - Deletes a specific Call Hunting from your Account.
DelCallHuntingResponse: Response body for Client::del_call_hunting (wire method delCallHunting).
DelCallParkingParams: - Deletes a specific Call Parking entry from your Account.
DelCallParkingResponse: Response body for Client::del_call_parking (wire method delCallParking).
DelCallRecordingParams: - Delete specific call recording, audio file and information related.
DelCallRecordingResponse: Response body for Client::del_call_recording (wire method delCallRecording).
DelCallbackParams: - Deletes a specific Callback from your Account.
DelCallbackResponse: Response body for Client::del_callback (wire method delCallback).
DelCallerIDFilteringParams: - Deletes a specific CallerID Filtering from your Account.
DelCallerIDFilteringResponse: Response body for Client::del_caller_id_filtering (wire method delCallerIDFiltering).
DelClientParams: - Deletes a specific reseller client from your Account.
DelClientResponse: Response body for Client::del_client (wire method delClient).
DelConferenceMemberParams: - Deletes a specific Member profile from your Account.
DelConferenceMemberResponse: Response body for Client::del_conference_member (wire method delConferenceMember).
DelConferenceParams: - Deletes a specific Conference from your Account.
DelConferenceResponse: Response body for Client::del_conference (wire method delConference).
DelDISAParams: - Deletes a specific DISA from your Account.
DelDISAResponse: Response body for Client::del_disa (wire method delDISA).
DelEmailToFAXParams: - Deletes a specific “Email to Fax configuration” from your Account.
DelEmailToFAXResponse: Response body for Client::del_email_to_fax (wire method delEmailToFax).
DelFAXFolderParams: - Deletes a specific Fax Folder from your Account.
DelFAXFolderResponse: Response body for Client::del_fax_folder (wire method delFaxFolder).
DelForwardingParams: - Deletes a specific Forwarding from your Account.
DelForwardingResponse: Response body for Client::del_forwarding (wire method delForwarding).
DelIVRParams: - Deletes a specific IVR from your Account.
DelIVRResponse: Response body for Client::del_ivr (wire method delIVR).
DelLocationParams: Parameters for Client::del_location (wire method delLocation).
DelLocationResponse: Response body for Client::del_location (wire method delLocation).
DelMemberFromConferenceParams: - Removes a member profile from a specific Conference from your Account
DelMemberFromConferenceResponse: Response body for Client::del_member_from_conference (wire method delMemberFromConference).
DelMessagesParams: - Deletes all messages in all servers from a specific Voicemail from your Account
DelMessagesResponse: Response body for Client::del_messages (wire method delMessages).
DelMusicOnHoldParams: - Deletes a specific custom Music on Hold.
DelMusicOnHoldResponse: Response body for Client::del_music_on_hold (wire method delMusicOnHold).
DelPhonebookGroupParams: - Deletes a specific Phonebook group from your Account.
DelPhonebookGroupResponse: Response body for Client::del_phonebook_group (wire method delPhonebookGroup).
DelPhonebookParams: - Deletes a specific Phonebook from your Account.
DelPhonebookResponse: Response body for Client::del_phonebook (wire method delPhonebook).
DelQueueParams: - Deletes a specific Queue from your Account.
DelQueueResponse: Response body for Client::del_queue (wire method delQueue).
DelRecordingParams: - Deletes a specific Recording from your Account.
DelRecordingResponse: Response body for Client::del_recording (wire method delRecording).
DelRingGroupParams: - Deletes a specific Ring Group from your Account.
DelRingGroupResponse: Response body for Client::del_ring_group (wire method delRingGroup).
DelSIPURIParams: - Deletes a specific SIP URI from your Account.
DelSIPURIResponse: Response body for Client::del_sip_uri (wire method delSIPURI).
DelStaticMemberParams: - Deletes a specific Static Member from Queue.
DelStaticMemberResponse: Response body for Client::del_static_member (wire method delStaticMember).
DelSubAccountParams: - Deletes a specific Sub Account from your Account
DelSubAccountResponse: Response body for Client::del_sub_account (wire method delSubAccount).
DelTimeConditionParams: - Deletes a specific Time Condition from your Account.
DelTimeConditionResponse: Response body for Client::del_time_condition (wire method delTimeCondition).
DelVoicemailParams: - Deletes a specific Voicemail from your Account
DelVoicemailResponse: Response body for Client::del_voicemail (wire method delVoicemail).
DeleteFAXMessageParams: - Deletes a specific Fax Message from your Account.
DeleteFAXMessageResponse: Response body for Client::delete_fax_message (wire method deleteFaxMessage).
DeleteMMSParams: - Deletes a specific MMS from your Account.
DeleteMMSResponse: Response body for Client::delete_mms (wire method deleteMMS).
DeleteSMSParams: - Deletes a specific SMS from your Account.
DeleteSMSResponse: Response body for Client::delete_sms (wire method deleteSMS).
E911AddressTypesParams: - Retrieves a list of e911 Address Types if no additional parameter is provided. - Retrieves a specific e911 Address Type if an Address code is provided.
E911AddressTypesResponse
E911AddressTypesResponseType: Response body for Client::e911_address_types (wire method e911AddressTypes).
E911CancelParams: - Cancel the e911 Service from a specific DID.
E911CancelResponse: Response body for Client::e911_cancel (wire method e911Cancel).
E911InfoParams: - Retrieves the e911 information from a specific DID.
E911InfoResponse
E911InfoResponseInfo: Response body for Client::e911_info (wire method e911Info).
E911ProvisionManuallyParams: - Subscribes your DID to the e911 Emergency Services. - All e911 information will be validated by the VoIP.ms staff.
E911ProvisionManuallyResponse: Response body for Client::e911_provision_manually (wire method e911ProvisionManually).
E911ProvisionParams: - Subscribes your DID to the e911 Emergency Services.
E911ProvisionResponse: Response body for Client::e911_provision (wire method e911Provision).
E911UpdateParams: - Updates the Information from your e911 Emergency Services Subscription.
E911UpdateResponse: Response body for Client::e911_update (wire method e911Update).
E911ValidateParams: - Validates your e911 information in order to start your e911 Emergency Services Subscription.
E911ValidateResponse: Response body for Client::e911_validate (wire method e911Validate).
GetAllowedCodecsParams: - Retrieves a list of Allowed Codecs if no additional parameter is provided. - Retrieves a specific Allowed Codec if a codec code is provided.
GetAllowedCodecsResponse
GetAllowedCodecsResponseAllowedCodec: Response body for Client::get_allowed_codecs (wire method getAllowedCodecs).
GetAuthTypesParams: - Retrieves a list of Authentication Types if no additional parameter is provided. - Retrieves a specific Authentication Type if an auth type code is provided.
GetAuthTypesResponse
GetAuthTypesResponseAuthType: Response body for Client::get_auth_types (wire method getAuthTypes).
GetBackOrdersParams: - Retrieves a list of backorder DIDs if no additional parameter is provided. - Retrieves a specific backorder DID if a backorder DID code is provided.
GetBackOrdersResponse
GetBackOrdersResponseBackOrder: Response body for Client::get_back_orders (wire method getBackOrders).
GetBalanceManagementParams: - Retrieves a list of Balance Management Options if no additional parameter is provided. - Retrieves a specific Balance Management Option if a code is provided.
GetBalanceManagementResponse
GetBalanceManagementResponseBalanceManagement: Response body for Client::get_balance_management (wire method getBalanceManagement).
GetBalanceParams: - Retrieves Balance for your Account if no additional parameter is provided. - Retrieves Balance and Calls Statistics for your Account if “advanced” parameter is true.
GetBalanceResponse
GetBalanceResponseBalance: Response body for Client::get_balance (wire method getBalance).
GetCDRParams: - Retrieves the Call Detail Records of all your calls.
GetCDRResponse
GetCDRResponseCDR: Response body for Client::get_cdr (wire method getCDR).
GetCallAccountsParams: - Retrieves all Sub Accounts if no additional parameter is provided. - Retrieves Reseller Client Accounts if Reseller Client ID is provided.
GetCallAccountsResponse
GetCallAccountsResponseAccount: Response body for Client::get_call_accounts (wire method getCallAccounts).
GetCallBillingParams: - Retrieves a list of Call Billing Options.
GetCallBillingResponse
GetCallBillingResponseCallBilling: Response body for Client::get_call_billing (wire method getCallBilling).
GetCallHuntingsParams: - Retrieves a list of Call Huntings if no additional parameter is provided. - Retrieves a specific Call Huntings if a Call Hunting code is provided.
GetCallHuntingsResponse
GetCallHuntingsResponseCallHunting: Response body for Client::get_call_huntings (wire method getCallHuntings).
GetCallParkingParams: - Retrieves all Call Parking entries if no additional parameter is provided. - Retrieves a specific Parking entry if a Call Parking ID is provided.
GetCallParkingResponse
GetCallParkingResponseCallHunting: Response body for Client::get_call_parking (wire method getCallParking).
GetCallRecordingParams: - Retrieves one especific call recording information, including the recording file on mp3 format.
GetCallRecordingResponse: Response body for Client::get_call_recording (wire method getCallRecording).
GetCallRecordingsParams: - Retrieves all call recordings related to account.
GetCallRecordingsResponse
GetCallRecordingsResponseRecording: Response body for Client::get_call_recordings (wire method getCallRecordings).
GetCallTranscriptionsParams: - Retrieves all Call Transcriptions if no additional parameter is provided.
GetCallTranscriptionsResponse
GetCallTranscriptionsResponseTranscription
GetCallTranscriptionsResponseTranscriptionRecognizedPhrase: Response body for Client::get_call_transcriptions (wire method getCallTranscriptions).
GetCallTypesParams: - Retrieves a list of Call Types and All DIDs if no additional parameter is provided. - Retrieves a list of Call Types and Reseller Client DIDs if a Reseller Client ID is provided.
GetCallTypesResponse
GetCallTypesResponseCallType: Response body for Client::get_call_types (wire method getCallTypes).
GetCallbacksParams: - Retrieves a list of Callbacks if no additional parameter is provided. - Retrieves a specific Callback if a Callback code is provided.
GetCallbacksResponse
GetCallbacksResponseCallback: Response body for Client::get_callbacks (wire method getCallbacks).
GetCallerIDFilteringParams: - Retrieves a list of CallerID Filterings if no additional parameter is provided. - Retrieves a specific CallerID Filtering if a CallerID Filtering code is provided.
GetCallerIDFilteringResponse
GetCallerIDFilteringResponseFiltering: Response body for Client::get_caller_id_filtering (wire method getCallerIDFiltering).
GetCarriersParams: - Retrieves a list of Carriers for Vanity Numbers if no additional parameter is provided. - Retrieves a specific Carrier for Vanity Numbers if a carrier code is provided.
GetCarriersResponse
GetCarriersResponseCarrier: Response body for Client::get_carriers (wire method getCarriers).
GetChargesParams: - Retrieves Charges made to a specific Reseller Client.
GetChargesResponse
GetChargesResponseCharge: Response body for Client::get_charges (wire method getCharges).
GetClientPackagesParams: - Retrieves a list of Packages for a specific Reseller Client.
GetClientPackagesResponse
GetClientPackagesResponsePackage: Response body for Client::get_client_packages (wire method getClientPackages).
GetClientThresholdParams: - Retrieves the Threshold Information for a specific Reseller Client.
GetClientThresholdResponse
GetClientThresholdResponseThresholdInformation: Response body for Client::get_client_threshold (wire method getClientThreshold).
GetClientsParams: - Retrieves a list of all Clients if no additional parameter is provided.- Retrieves a specific Reseller Client if a Reseller Client ID is provided. - Retrieves a specific Reseller Client if a Reseller Client e-mail is provided.
GetClientsResponse
GetClientsResponseClient: Response body for Client::get_clients (wire method getClients).
GetConferenceMembersParams: - Retrieves a list of Member profiles if no additional parameter is provided. - Retrieves a specific member if a member code is provided.
GetConferenceMembersResponse
GetConferenceMembersResponseMember: Response body for Client::get_conference_members (wire method getConferenceMembers).
GetConferenceParams: - Retrieves a list of Conferences if no additional parameter is provided. - Retrieves a specific Conference if a conference code is provided.
GetConferenceRecordingFileParams: - Retrieves a specific Recording File data in Base64 format.
GetConferenceRecordingFileResponse
GetConferenceRecordingFileResponseRecording: Response body for Client::get_conference_recording_file (wire method getConferenceRecordingFile).
GetConferenceRecordingsParams: - Retrieves a list of recordings of a specific conference.
GetConferenceRecordingsResponse
GetConferenceRecordingsResponseRecording: Response body for Client::get_conference_recordings (wire method getConferenceRecordings).
GetConferenceResponse
GetConferenceResponseConference: Response body for Client::get_conference (wire method getConference).
GetCountriesParams: - Retrieves a list of Countries if no additional parameter is provided. - Retrieves a specific Country if a country code is provided.
GetCountriesResponse
GetCountriesResponseCountry: Response body for Client::get_countries (wire method getCountries).
GetDIDCountriesParams: - Retrieves a list of Countries for International DIDs if no country code is provided. - Retrieves a specific Country for International DIDs if a country code is provided.
GetDIDCountriesResponse
GetDIDCountriesResponseCountry: Response body for Client::get_did_countries (wire method getDIDCountries).
GetDIDsCANParams: - Retrives a list of Canadian DIDs by Province and Ratecenter.
GetDIDsCANResponse
GetDIDsCANResponseDID: Response body for Client::get_dids_can (wire method getDIDsCAN).
GetDIDsInfoParams: - Retrieves information from all your DIDs if no additional parameter is provided. - Retrieves information from Reseller Client’s DIDs if a Reseller Client ID is provided. - Retrieves information from Sub Account’s DIDs if a Sub Accunt is provided. - Retrieves information from a specific DID if a DID Number is provided. - Retrieves SMS information from a specific DID if the SMS is available.
GetDIDsInfoResponse
GetDIDsInfoResponseDID: Response body for Client::get_dids_info (wire method getDIDsInfo).
GetDIDsInternationalGeographicParams: - Retrieves a list of International Geographic DIDs by Country.
GetDIDsInternationalGeographicResponse
GetDIDsInternationalGeographicResponseLocation: Response body for Client::get_dids_international_geographic (wire method getDIDsInternationalGeographic).
GetDIDsInternationalNationalParams: - Retrieves a list of International National DIDs by Country.
GetDIDsInternationalNationalResponse
GetDIDsInternationalNationalResponseLocation: Response body for Client::get_dids_international_national (wire method getDIDsInternationalNational).
GetDIDsInternationalTollFreeParams: - Retrieves a list of International TollFree DIDs by Country.
GetDIDsInternationalTollFreeResponse
GetDIDsInternationalTollFreeResponseLocation: Response body for Client::get_dids_international_toll_free (wire method getDIDsInternationalTollFree).
GetDIDsUSAParams: - Retrives a list of USA DIDs by State and Ratecenter.
GetDIDsUSAResponse
GetDIDsUSAResponseDID: Response body for Client::get_dids_usa (wire method getDIDsUSA).
GetDIDvPRIParams: - Retrives the list of DIDs assigned to the VPRI.
GetDIDvPRIResponse: Response body for Client::get_did_vpri (wire method getDIDvPRI).
GetDISAsParams: - Retrieves a list of DISAs if no additional parameter is provided. - Retrieves a specific DISA if a DISA code is provided.
GetDISAsResponse
GetDISAsResponseDISA: Response body for Client::get_disas (wire method getDISAs).
GetDTMFModesParams: - Retrieves a list of DTMF Modes if no additional parameter is provided. - Retrieves a specific DTMF Mode if a DTMF mode code is provided.
GetDTMFModesResponse
GetDTMFModesResponseDTMFMode: Response body for Client::get_dtmf_modes (wire method getDTMFModes).
GetDepositsParams: - Retrieves Deposits made for a specific Reseller Client.
GetDepositsResponse
GetDepositsResponseDeposit: Response body for Client::get_deposits (wire method getDeposits).
GetDeviceTypesParams: - Retrieves a list of Device Types if no additional parameter is provided. - Retrieves a specific Device Type if a device type code is provided.
GetDeviceTypesResponse
GetDeviceTypesResponseDeviceType: Response body for Client::get_device_types (wire method getDeviceTypes).
GetEmailToFAXParams: - Retrieves a list of “Email to Fax configurations” from your account if no additional parameter is provided. - Retrieves a specific “Email to Fax configuration” from your account if a ID is provided.
GetEmailToFAXResponse
GetEmailToFAXResponseEmailToFAX: Response body for Client::get_email_to_fax (wire method getEmailToFax).
GetFAXFoldersParams: - Retrieves a list of Fax Folders from your account.
GetFAXFoldersResponse
GetFAXFoldersResponseFolder: Response body for Client::get_fax_folders (wire method getFaxFolders).
GetFAXMessagePDFParams: - Retrieves a Base64 code of the Fax Message to create a PDF file.
GetFAXMessagePDFResponse: Response body for Client::get_fax_message_pdf (wire method getFaxMessagePDF).
GetFAXMessagesParams: - Retrieves a list of Fax Messages. - Retrieves a specific Fax Message if a Fax Message ID is provided.
GetFAXMessagesResponse
GetFAXMessagesResponseFAX: Response body for Client::get_fax_messages (wire method getFaxMessages).
GetFAXNumbersInfoParams: - Retrieves a list of Fax Numbers.
GetFAXNumbersInfoResponse
GetFAXNumbersInfoResponseNumber: Response body for Client::get_fax_numbers_info (wire method getFaxNumbersInfo).
GetFAXNumbersPortabilityParams: - Shows if a Fax Number can be ported into our network
GetFAXNumbersPortabilityResponse: Response body for Client::get_fax_numbers_portability (wire method getFaxNumbersPortability).
GetFAXProvincesParams: - Retrieves a list of Canadian Fax Provinces if no additional parameter is provided. - Retrieves a specific Canadian Fax Province if a province code is provided.
GetFAXProvincesResponse
GetFAXProvincesResponseProvince: Response body for Client::get_fax_provinces (wire method getFaxProvinces).
GetFAXRateCentersCANParams: - Retrieves a list of Canadian Ratecenters by Province.
GetFAXRateCentersCANResponse
GetFAXRateCentersCANResponseRatecenter: Response body for Client::get_fax_rate_centers_can (wire method getFaxRateCentersCAN).
GetFAXRateCentersUSAParams: - Retrieves a list of USA Ratecenters by State.
GetFAXRateCentersUSAResponse
GetFAXRateCentersUSAResponseRatecenter: Response body for Client::get_fax_rate_centers_usa (wire method getFaxRateCentersUSA).
GetFAXStatesParams: - Retrieves a list of American Fax States if no additional parameter is provided. - Retrieves a specific American Fax State if a state code is provided.
GetFAXStatesResponse
GetFAXStatesResponseState: Response body for Client::get_fax_states (wire method getFaxStates).
GetForwardingsParams: - Retrieves a list of Forwardings if no additional parameter is provided. - Retrieves a specific Forwarding if a fwd code is provided.
GetForwardingsResponse
GetForwardingsResponseForwarding: Response body for Client::get_forwardings (wire method getForwardings).
GetIPParams: - Shows the IP used by the client application requesting information from the API * this is the only function not using the IP for authentication. * the IP returned should be the one used in the API Configuration.
GetIPResponse: Response body for Client::get_ip (wire method getIP).
GetIVRsParams: - Retrieves a list of IVRs if no additional parameter is provided. - Retrieves a specific IVR if a IVR code is provided.
GetIVRsResponse
GetIVRsResponseIVR: Response body for Client::get_ivrs (wire method getIVRs).
GetInternationalTypesParams: - Retrieves a list of Types for International DIDs if no additional parameter is provided. - Retrieves a specific Types for International DIDs if a type code is provided.
GetInternationalTypesResponse
GetInternationalTypesResponseType: Response body for Client::get_international_types (wire method getInternationalTypes).
GetJoinWhenEmptyTypesParams: - Retrieves a list of ‘JoinWhenEmpty’ Types if no additional parameter is provided. - Retrieves a specific ‘JoinWhenEmpty’ Types if a type code is provided.
GetJoinWhenEmptyTypesResponse
GetJoinWhenEmptyTypesResponseType: Response body for Client::get_join_when_empty_types (wire method getJoinWhenEmptyTypes).
GetLNPAttachListParams: - Retrieve the list of invoice (attached) files from a given portability process.
GetLNPAttachListResponse
GetLNPAttachListResponseList: Response body for Client::get_lnp_attach_list (wire method getLNPAttachList).
GetLNPAttachParams: - Retrieve the details of an attached invoice.
GetLNPAttachResponse: Response body for Client::get_lnp_attach (wire method getLNPAttach).
GetLNPDetailsParams: - Retrieve the details of a given portability process.
GetLNPDetailsResponse
GetLNPDetailsResponseAttachment
GetLNPDetailsResponseNote
GetLNPDetailsResponseNumber: Response body for Client::get_lnp_details (wire method getLNPDetails).
GetLNPListParams: - Retrieve the full list of all your portability processes.
GetLNPListResponse
GetLNPListResponseList: Response body for Client::get_lnp_list (wire method getLNPList).
GetLNPListStatusParams: - Retrieve the list of possible status of a portability process.
GetLNPListStatusResponse: Response body for Client::get_lnp_list_status (wire method getLNPListStatus).
GetLNPNotesParams: - Retrieve the list of notes from the given portability process.
GetLNPNotesResponse
GetLNPNotesResponseList: Response body for Client::get_lnp_notes (wire method getLNPNotes).
GetLNPStatusParams: - Retrieve the current status of a given portability process.
GetLNPStatusResponse: Response body for Client::get_lnp_status (wire method getLNPStatus).
GetLanguagesParams: - Retrieves a list of Languages if no additional parameter is provided. - Retrieves a specific Language if a language code is provided.
GetLanguagesResponse
GetLanguagesResponseLanguage: Response body for Client::get_languages (wire method getLanguages).
GetLocalesParams: - Retrieves a list of locale codes if no additional parameter is provided. - Retrieves a specific locale code if a language code is provided.
GetLocalesResponse
GetLocalesResponseLocale: Response body for Client::get_locales (wire method getLocales).
GetLocationsParams: Parameters for Client::get_locations (wire method getLocations).
GetLocationsResponse: Response body for Client::get_locations (wire method getLocations).
GetLockInternationalParams: - Retrieves a list of Lock Modes if no additional parameter is provided. - Retrieves a specific Lock Mode if a lock code is provided.
GetLockInternationalResponse
GetLockInternationalResponseLockInternational: Response body for Client::get_lock_international (wire method getLockInternational).
GetMMSParams: - Retrieves a list of MMS messages by: date range, mms type, DID number, and contact.
GetMMSResponse
GetMMSResponseSMS: Response body for Client::get_mms (wire method getMMS).
GetMediaMMSParams: - Retrieves media files from the message.
GetMediaMMSResponse: Response body for Client::get_media_mms (wire method getMediaMMS).
GetMusicOnHoldParams: - Retrieves a list of Music on Hold Options if no additional parameter is provided. - Retrieves a specific Music on Hold Option if a MOH code is provided.
GetMusicOnHoldResponse
GetMusicOnHoldResponseMusicOnHold: Response body for Client::get_music_on_hold (wire method getMusicOnHold).
GetNATParams: - Retrieves a list of NAT Options if no additional parameter is provided. - Retrieves a specific NAT Option if a NAT code is provided.
GetNATResponse
GetNATResponseNAT: Response body for Client::get_nat (wire method getNAT).
GetPackagesParams: - Retrieves a list of Packages if no additional parameter is provided.- Retrieves a specific Package if a package code is provided.
GetPackagesResponse
GetPackagesResponsePackage: Response body for Client::get_packages (wire method getPackages).
GetPhonebookGroupsParams: - Retrieves a list of Phonebook groups if no additional parameter is provided. - Retrieves a list of Phonebook groups if a name is provided. - Retrieves a specific Phonebook group if a group ID is provided.
GetPhonebookGroupsResponse
GetPhonebookGroupsResponsePhonebook: Response body for Client::get_phonebook_groups (wire method getPhonebookGroups).
GetPhonebookParams: - Retrieves a list of Phonebook entries if no additional parameter is provided. - Retrieves a list of Phonebook entries if a name is provided. - Retrieves a specific Phonebook entry if a Phonebook code is provided. - Retrieves a list of Phonebook entries if a phonebook group name is provided. - Retrieves a list of Phonebook entries if a phonebook group code is provided.
GetPhonebookResponse
GetPhonebookResponsePhonebook: Response body for Client::get_phonebook (wire method getPhonebook).
GetPlayInstructionsParams: - Retrieves a list of Play Instructions modes if no additional parameter is provided. - Retrieves a specific Play Instructions mode if a play code is provided.
GetPlayInstructionsResponse
GetPlayInstructionsResponsePlayInstruction: Response body for Client::get_play_instructions (wire method getPlayInstructions).
GetPortabilityParams: - Shows if a DID Number can be ported into our network. - Display plans and rates available if the DID Number can be ported into our network.
GetPortabilityResponse
GetPortabilityResponsePlan: Response body for Client::get_portability (wire method getPortability).
GetProtocolsParams: - Retrieves a list of Protocols if no additional parameter is provided. - Retrieves a specific Protocol if a protocol code is provided.
GetProtocolsResponse
GetProtocolsResponseProtocol: Response body for Client::get_protocols (wire method getProtocols).
GetProvincesParams: - Retrieves a list of Canadian Provinces.
GetProvincesResponse
GetProvincesResponseProvince: Response body for Client::get_provinces (wire method getProvinces).
GetQueuesParams: - Retrieves a list of Queue entries if no additional parameter is provided. - Retrieves a specific Queue entry if a Queue code is provided.
GetQueuesResponse
GetQueuesResponseQueue: Response body for Client::get_queues (wire method getQueues).
GetRateCentersCANParams: - Retrieves a list of Canadian Ratecenters by Province.
GetRateCentersCANResponse
GetRateCentersCANResponseRatecenter: Response body for Client::get_rate_centers_can (wire method getRateCentersCAN).
GetRateCentersUSAParams: - Retrieves a list of USA Ratecenters by State.
GetRateCentersUSAResponse
GetRateCentersUSAResponseRatecenter: Response body for Client::get_rate_centers_usa (wire method getRateCentersUSA).
GetRatesParams: - Retrieves the Rates for a specific Package and a Search term.
GetRatesResponse
GetRatesResponseRate: Response body for Client::get_rates (wire method getRates).
GetRecordingFileParams: - Retrieves a specific Recording File data in Base64 format.
GetRecordingFileResponse
GetRecordingFileResponseRecording: Response body for Client::get_recording_file (wire method getRecordingFile).
GetRecordingsParams: - Retrieves a list of Recordings if no additional parameter is provided. - Retrieves a specific Recording if a Recording code is provided.
GetRecordingsResponse
GetRecordingsResponseRecording: Response body for Client::get_recordings (wire method getRecordings).
GetRegistrationStatusParams: - Retrieves the Registration Status of all accounts if no account is provided.
GetRegistrationStatusResponse
GetRegistrationStatusResponseRegistration: Response body for Client::get_registration_status (wire method getRegistrationStatus).
GetReportEstimatedHoldTimeParams: - Retrieves a list of ‘ReportEstimateHoldTime’ Types if no additional parameter is provided. - Retrieves a specific ‘ReportEstimateHoldTime’ Type if a type code is provided.
GetReportEstimatedHoldTimeResponse
GetReportEstimatedHoldTimeResponseType: Response body for Client::get_report_estimated_hold_time (wire method getReportEstimatedHoldTime).
GetResellerBalanceParams: - Retrieves Balance and Calls Statistics for a specific Reseller Client for the last 30 days and current day.
GetResellerBalanceResponse
GetResellerBalanceResponseBalance: Response body for Client::get_reseller_balance (wire method getResellerBalance).
GetResellerCDRParams: - Retrieves the Call Detail Records for a specific Reseller Client.
GetResellerCDRResponse
GetResellerCDRResponseCDR: Response body for Client::get_reseller_cdr (wire method getResellerCDR).
GetResellerMMSParams: - Retrieves a list of MMS messages for a specific Reseller Client. by: date range, mms type, DID number, and contact
GetResellerMMSResponse
GetResellerMMSResponseSMS: Response body for Client::get_reseller_mms (wire method getResellerMMS).
GetResellerSMSParams: - Retrieves a list of SMS messages for a specific Reseller Client. by: date range, sms type, DID number, and contact
GetResellerSMSResponse
GetResellerSMSResponseSMS: Response body for Client::get_reseller_sms (wire method getResellerSMS).
GetRingGroupsParams: - Retrieves a list of Ring Groups if no additional parameter is provided. - Retrieves a specific Ring Group if a ring group code is provided.
GetRingGroupsResponse
GetRingGroupsResponseRingGroup: Response body for Client::get_ring_groups (wire method getRingGroups).
GetRingStrategiesParams: - Retrieves a list of Ring Strategies if no additional parameter is provided. - Retrieves a specific Ring Strategy if a ring strategy code is provided.
GetRingStrategiesResponse
GetRingStrategiesResponseStrategy: Response body for Client::get_ring_strategies (wire method getRingStrategies).
GetRoutesParams: - Retrieves a list of Route Options if no additional parameter is provided. - Retrieves a specific Route Option if a route code is provided.
GetRoutesResponse
GetRoutesResponseRoute: Response body for Client::get_routes (wire method getRoutes).
GetSIPURIsParams: - Retrieves a list of SIP URIs if no additional parameter is provided. - Retrieves a specific SIP URI if a SIP URI code is provided.
GetSIPURIsResponse
GetSIPURIsResponseSIPURI: Response body for Client::get_sip_uris (wire method getSIPURIs).
GetSMSParams: - Retrieves a list of SMS messages by: date range, sms type, DID number, and contact.
GetSMSResponse
GetSMSResponseSMS: Response body for Client::get_sms (wire method getSMS).
GetServersInfoParams: - Retrieves a list of Servers with their info if no additional parameter is provided. - Retrieves a specific Server with its info if a Server POP is provided.
GetServersInfoResponse
GetServersInfoResponseServer: Response body for Client::get_servers_info (wire method getServersInfo).
GetStatesParams: - Retrieves a list of USA States.
GetStatesResponse
GetStatesResponseState: Response body for Client::get_states (wire method getStates).
GetStaticMembersParams: - Retrieves a list of Static Members from a queue if no additional parameter is provided. - Retrieves a specific Static Member from a queue if Queue ID and Member ID are provided
GetStaticMembersResponse
GetStaticMembersResponseMember: Response body for Client::get_static_members (wire method getStaticMembers).
GetSubAccountsParams: - Retrieves all Sub Accounts if no additional parameter is provided. - Retrieves Reseller Client Accounts if Reseller Client ID is provided. - Retrieves a specific Sub Account if a Sub Account is provided.
GetSubAccountsResponse
GetSubAccountsResponseAccount: Response body for Client::get_sub_accounts (wire method getSubAccounts).
GetTerminationRatesParams: - Retrieves the Rates for a specific Route (Premium, Value) and a Search term.
GetTerminationRatesResponse
GetTerminationRatesResponseRate
GetTerminationRatesResponseRoute: Response body for Client::get_termination_rates (wire method getTerminationRates).
GetTimeConditionsParams: - Retrieves a list of Time Conditions if no additional parameter is provided. - Retrieves a specific Time Condition if a time condition code is provided.
GetTimeConditionsResponse
GetTimeConditionsResponseTimecondition: Response body for Client::get_time_conditions (wire method getTimeConditions).
GetTimezonesParams: - Retrieves a list of Timezones if no additional parameter is provided. - Retrieves a specific Timezone if a timezone code is provided.
GetTimezonesResponse
GetTimezonesResponseTimezone: Response body for Client::get_timezones (wire method getTimezones).
GetTransactionHistoryParams: - Retrieves the Transaction History records between two dates.
GetTransactionHistoryResponse
GetTransactionHistoryResponseTransaction: Response body for Client::get_transaction_history (wire method getTransactionHistory).
GetVPRIsParams: - Retrieves a list of vpri.
GetVPRIsResponse
GetVPRIsResponseVPRI: Response body for Client::get_vpris (wire method getVPRIs).
GetVoicemailAttachmentFormatsParams: - Retrieves a list of Email Attachment Format Options if no additional parameter is provided. - Retrieves a specific Email Attachment Format Option if a format value is provided.
GetVoicemailAttachmentFormatsResponse
GetVoicemailAttachmentFormatsResponseEmailAttachmentFormat: Response body for Client::get_voicemail_attachment_formats (wire method getVoicemailAttachmentFormats).
GetVoicemailFoldersParams: - Retrieves a list of default Voicemail Folders if no additional parameter is provided. - Retrieves a list of Voicemail Folders within a mailbox if mailbox parameter is provided. - Retrieves a specific Folder if a folder name is provided.
GetVoicemailFoldersResponse
GetVoicemailFoldersResponseFolder: Response body for Client::get_voicemail_folders (wire method getVoicemailFolders).
GetVoicemailMessageFileParams: - Retrieves a specific Voicemail Message File in Base64 format.
GetVoicemailMessageFileResponse
GetVoicemailMessageFileResponseMessage: Response body for Client::get_voicemail_message_file (wire method getVoicemailMessageFile).
GetVoicemailMessagesParams: - Retrieves a list of Voicemail Messages if mailbox parameter is provided. - Retrieves a list of Voicemail Messages in a Folder if a folder is provided. - Retrieves a list of Voicemail Messages in a date range if a from and to are provided.
GetVoicemailMessagesResponse
GetVoicemailMessagesResponseMessage: Response body for Client::get_voicemail_messages (wire method getVoicemailMessages).
GetVoicemailSetupsParams: - Retrieves a list of Voicemail Setup Options if no additional parameter is provided. - Retrieves a specific Voicemail Setup Option if a voicemail setup code is provided.
GetVoicemailSetupsResponse
GetVoicemailSetupsResponseVoicemailsetup: Response body for Client::get_voicemail_setups (wire method getVoicemailSetups).
GetVoicemailTranscriptionsParams: - Retrieves all Voicemail Transcriptions if no additional parameter is provided.
GetVoicemailTranscriptionsResponse
GetVoicemailTranscriptionsResponseMessage: Response body for Client::get_voicemail_transcriptions (wire method getVoicemailTranscriptions).
GetVoicemailsParams: - Retrieves a list of Voicemails if no additional parameter is provided. - Retrieves a specific Voicemail if a voicemail code is provided.
GetVoicemailsResponse
GetVoicemailsResponseVoicemail: Response body for Client::get_voicemails (wire method getVoicemails).
MailFAXMessagePDFParams: - Send a Fax Message attached as a PDF file to an email destination.
MailFAXMessagePDFResponse: Response body for Client::mail_fax_message_pdf (wire method mailFaxMessagePDF).
MarkListenedVoicemailMessageParams: - Mark a Voicemail Message as Listened or Unlistened. - If value is ‘yes’, the voicemail message will be marked as listened and will be moved to the Old Folder. - If value is ‘no’, the voicemail message will be marked as not-listened and will be moved to the INBOX Folder.
MarkListenedVoicemailMessageResponse: Response body for Client::mark_listened_voicemail_message (wire method markListenedVoicemailMessage).
MarkUrgentVoicemailMessageParams: - Mark Voicemail Message as Urgent or not Urgent. - If value is ‘yes’, the voicemail message will be marked as urgent and will be moved to the Urgent Folder. - If value is ‘no’, the voicemail message will be unmarked as urgent and will be moved to the INBOX Folder.
MarkUrgentVoicemailMessageResponse: Response body for Client::mark_urgent_voicemail_message (wire method markUrgentVoicemailMessage).
MoveFAXMessageParams: - Moves a Fax Message to a different folder.
MoveFAXMessageResponse: Response body for Client::move_fax_message (wire method moveFaxMessage).
MoveFolderVoicemailMessageParams: - Move Voicemail Message to a Destination Folder.
MoveFolderVoicemailMessageResponse: Response body for Client::move_folder_voicemail_message (wire method moveFolderVoicemailMessage).
OrderDIDInternationalGeographicParams: - Orders and Adds new International Geographic DID Numbers to the Account.
OrderDIDInternationalGeographicResponse: Response body for Client::order_did_international_geographic (wire method orderDIDInternationalGeographic).
OrderDIDInternationalNationalParams: - Orders and Adds new International National DID Numbers to the Account.
OrderDIDInternationalNationalResponse: Response body for Client::order_did_international_national (wire method orderDIDInternationalNational).
OrderDIDInternationalTollFreeParams: - Orders and Adds new International TollFree DID Numbers to the Account.
OrderDIDInternationalTollFreeResponse: Response body for Client::order_did_international_toll_free (wire method orderDIDInternationalTollFree).
OrderDIDParams: - Orders and Adds a new DID Number to the Account.
OrderDIDResponse: Response body for Client::order_did (wire method orderDID).
OrderDIDVirtualParams: - Orders and Adds a new Virtual DID Number to the Account.
OrderDIDVirtualResponse: Response body for Client::order_did_virtual (wire method orderDIDVirtual).
OrderFAXNumberParams: - Orders and Adds a new Fax Number to the Account.
OrderFAXNumberResponse: Response body for Client::order_fax_number (wire method orderFaxNumber).
OrderTollFreeParams: - Orders and Adds a new Toll Free Number to the Account.
OrderTollFreeResponse: Response body for Client::order_toll_free (wire method orderTollFree).
OrderVanityParams: - Orders and Adds a new Vanity Toll Free Number to the Account.
OrderVanityResponse: Response body for Client::order_vanity (wire method orderVanity).
RemoveDIDvPRIParams: - Removes a DID from a VPRI
RemoveDIDvPRIResponse: Response body for Client::remove_did_vpri (wire method removeDIDvPRI).
SearchDIDsCANParams: - Searches for Canadian DIDs by Province using a Search Criteria.
SearchDIDsCANResponse
SearchDIDsCANResponseDID: Response body for Client::search_dids_can (wire method searchDIDsCAN).
SearchDIDsUSAParams: - Searches for USA DIDs by State using a Search Criteria.
SearchDIDsUSAResponse
SearchDIDsUSAResponseDID: Response body for Client::search_dids_usa (wire method searchDIDsUSA).
SearchFAXAreaCodeCANParams: - Retrieves a list of Canadian Ratecenters searched by Area Code.
SearchFAXAreaCodeCANResponse
SearchFAXAreaCodeCANResponseRatecenter: Response body for Client::search_fax_area_code_can (wire method searchFaxAreaCodeCAN).
SearchFAXAreaCodeUSAParams: - Retrieves a list of USA Ratecenters searched by Area Code.
SearchFAXAreaCodeUSAResponse
SearchFAXAreaCodeUSAResponseRatecenter: Response body for Client::search_fax_area_code_usa (wire method searchFaxAreaCodeUSA).
SearchTollFreeCANUSParams: - Searches for USA/Canada Toll Free Numbers using a Search Criteria. - Shows all USA/Canada Toll Free Numbers available if no criteria is provided.
SearchTollFreeCANUSResponse
SearchTollFreeCANUSResponseDID: Response body for Client::search_toll_free_can_us (wire method searchTollFreeCanUS).
SearchTollFreeUSAParams: - Searches for USA Toll Free Numbers using a Search Criteria. - Shows all USA Toll Free Numbers available if no criteria is provided.
SearchTollFreeUSAResponse
SearchTollFreeUSAResponseDID: Response body for Client::search_toll_free_usa (wire method searchTollFreeUSA).
SearchVanityParams: - Searches for Vanity Toll Free Numbers using a Search Criteria.
SearchVanityResponse
SearchVanityResponseDID: Response body for Client::search_vanity (wire method searchVanity).
SendCallRecordingEmailParams: - Send information and audio file to email account.
SendCallRecordingEmailResponse: Response body for Client::send_call_recording_email (wire method sendCallRecordingEmail).
SendFAXMessageParams: - Send a Fax message to a Destination Number.
SendFAXMessageResponse: Response body for Client::send_fax_message (wire method sendFaxMessage).
SendMMSParams: - Send a MMS message to a Destination Number.
SendMMSResponse: Response body for Client::send_mms (wire method sendMMS).
SendSMSParams: - Send a SMS message to a Destination Number.
SendSMSResponse: Response body for Client::send_sms (wire method sendSMS).
SendVoicemailEmailParams: - Send a Voicemail Message File to an Email Address.
SendVoicemailEmailResponse: Response body for Client::send_voicemail_email (wire method sendVoicemailEmail).
SetCallHuntingParams: - Updates a specific Call Hunting if a Call Hunting code is provided. - Adds a new Call Hunting if no Call Hunting code is provided.
SetCallHuntingResponse: Response body for Client::set_call_hunting (wire method setCallHunting).
SetCallParkingParams: - Updates a specific Call Parking entry if a Call Parking ID is provided. - Adds a new Call Parking entry if no Call Parking ID is provided.
SetCallParkingResponse: Response body for Client::set_call_parking (wire method setCallParking).
SetCallbackParams: - Updates a specific Callback if a callback code is provided. - Adds a new Callback entry if no callback code is provided.
SetCallbackResponse: Response body for Client::set_callback (wire method setCallback).
SetCallerIDFilteringParams: - Updates a specific Caller ID Filtering if a filtering code is provided. - Adds a new Caller ID Filtering if no filtering code is provided.
SetCallerIDFilteringResponse: Response body for Client::set_caller_id_filtering (wire method setCallerIDFiltering).
SetClientParams: - Updates Reseller Client information.
SetClientResponse: Response body for Client::set_client (wire method setClient).
SetClientThresholdParams: - Update the Threshold Amount for a specific Reseller Client.- Update the Threshold notification e-mail for a specific Reseller Client if the e-mail address is provided.
SetClientThresholdResponse: Response body for Client::set_client_threshold (wire method setClientThreshold).
SetConferenceMemberParams: - Updates a specific Member profile if a member code is provided. - Adds a new Member profile entry if no member code is provided.
SetConferenceMemberResponse: Response body for Client::set_conference_member (wire method setConferenceMember).
SetConferenceParams: - Updates a specific Conference if a conference code is provided. - Adds a new Conference entry if no conference code is provided.
SetConferenceResponse: Response body for Client::set_conference (wire method setConference).
SetDIDBillingTypeParams: - Updates the Billing Plan from a specific DID.
SetDIDBillingTypeResponse: Response body for Client::set_did_billing_type (wire method setDIDBillingType).
SetDIDInfoParams: - Updates the information from a specific DID.
SetDIDInfoResponse: Response body for Client::set_did_info (wire method setDIDInfo).
SetDIDPOPParams: - Updates the POP from a specific DID.
SetDIDPOPResponse: Response body for Client::set_did_pop (wire method setDIDPOP).
SetDIDRoutingParams: - Updates the Routing from a specific DID.
SetDIDRoutingResponse: Response body for Client::set_did_routing (wire method setDIDRouting).
SetDIDVoicemailParams: - Updates the Voicemail from a specific DID.
SetDIDVoicemailResponse: Response body for Client::set_did_voicemail (wire method setDIDVoicemail).
SetDISAParams: - Updates a specific DISA if a disa code is provided. - Adds a new DISA entry if no disa code is provided.
SetDISAResponse: Response body for Client::set_disa (wire method setDISA).
SetEmailToFAXParams: - Create or update the information of a specific “Email to Fax configuration”.
SetEmailToFAXResponse: Response body for Client::set_email_to_fax (wire method setEmailToFax).
SetFAXFolderParams: - Create or update the information of a specific Fax Folder.
SetFAXFolderResponse: Response body for Client::set_fax_folder (wire method setFaxFolder).
SetFAXNumberEmailParams: - Updates the email configuration from a specific Fax Number.
SetFAXNumberEmailResponse: Response body for Client::set_fax_number_email (wire method setFaxNumberEmail).
SetFAXNumberInfoParams: - Updates the information from a specific Fax Number.
SetFAXNumberInfoResponse: Response body for Client::set_fax_number_info (wire method setFaxNumberInfo).
SetFAXNumberURLCallbackParams: - Updates the url callback configuration from a specific Fax Number.
SetFAXNumberURLCallbackResponse: Response body for Client::set_fax_number_url_callback (wire method setFaxNumberURLCallback).
SetForwardingParams: - Updates a specific Forwarding if a fwd code is provided. - Adds a new Forwarding entry if no fwd code is provided.
SetForwardingResponse: Response body for Client::set_forwarding (wire method setForwarding).
SetIVRParams: - Updates a specific IVR if an IVR code is provided. - Adds a new IVR entry if no IVR code is provided.
SetIVRResponse: Response body for Client::set_ivr (wire method setIVR).
SetLocationParams: Parameters for Client::set_location (wire method setLocation).
SetLocationResponse: Response body for Client::set_location (wire method setLocation).
SetMusicOnHoldParams: Parameters for Client::set_music_on_hold (wire method setMusicOnHold).
SetMusicOnHoldResponse: Response body for Client::set_music_on_hold (wire method setMusicOnHold).
SetPhonebookGroupParams: - Updates a specific Phonebook group if a phonebook code is provided. - Adds a new Phonebook group if no phonebook group code is provided. - Assigns or modifies group members if a member list is provided
SetPhonebookGroupResponse: Response body for Client::set_phonebook_group (wire method setPhonebookGroup).
SetPhonebookParams: - Updates a specific Phonebook entry if a phonebook code is provided. - Adds a new Phonebook entry if no phonebook code is provided.
SetPhonebookResponse: Response body for Client::set_phonebook (wire method setPhonebook).
SetQueueParams: - Updates a specific Queue entry if a queue code is provided. - Adds a new Queue entry if no queue code is provided.
SetQueueResponse: Response body for Client::set_queue (wire method setQueue).
SetRecordingParams: - Updates a specific Recording File if a Recording ID is provided. - Adds a new Recording file entry if no Recording ID is provided.
SetRecordingResponse: Response body for Client::set_recording (wire method setRecording).
SetRingGroupParams: - Updates a specific Ring Group if a ring group code is provided. - Adds a new Ring Group entry if no ring group code is provided.
SetRingGroupResponse: Response body for Client::set_ring_group (wire method setRingGroup).
SetSIPURIParams: - Updates a specific SIP URI if a SIP URI code is provided. - Adds a new SIP URI entry if no SIP URI code is provided.
SetSIPURIResponse: Response body for Client::set_sip_uri (wire method setSIPURI).
SetSMSParams: - Enable/Disable the SMS Service for a DID - Change the SMS settings for a DID
SetSMSResponse: Response body for Client::set_sms (wire method setSMS).
SetStaticMemberParams: - Updates a specific Member from queue if a Member code is provided. - Adds a new Member to Queue if no Member code is provided.
SetStaticMemberResponse: Response body for Client::set_static_member (wire method setStaticMember).
SetSubAccountParams: - Updates Sub Account information.
SetSubAccountResponse: Response body for Client::set_sub_account (wire method setSubAccount).
SetTimeConditionParams: - Updates a specific Time Condition if a time condition code is provided. - Adds a new Time Condition entry if no time condition code is provided.
SetTimeConditionResponse: Response body for Client::set_time_condition (wire method setTimeCondition).
SetVoicemailParams: - Updates the information from a specific Voicemail.
SetVoicemailResponse: Response body for Client::set_voicemail (wire method setVoicemail).
SignupClientParams: - Signs a new Reseller Client to your Reseller Account.
SignupClientResponse: Response body for Client::signup_client (wire method signupClient).
TimezoneOffset: A UTC offset in hours, the wire form of the record-listing timezone knob.
UnconnectDIDParams: - Unconnects specific DID from Reseller Client Sub Account.
UnconnectDIDResponse: Response body for Client::unconnect_did (wire method unconnectDID).
UnconnectFAXParams: - Unconnects specific FAX DID from Reseller Client Sub Account.
UnconnectFAXResponse: Response body for Client::unconnect_fax (wire method unconnectFAX).

Enums§

ApiStatus: A non-success status returned by the VoIP.ms API.
CallPickupBehavior: Sub-account call-pickup permissions.
DialingMode: Outgoing-call dialing mode for a sub-account.
DidBillingType: DID billing model.
DtmfMode: DTMF transport mode for SIP sub-accounts.
EmailAttachmentFormat: Voicemail email attachment format.
Error: Errors returned by the VoIP.ms client.
EstimatedHoldTimeAnnounce: When to include estimated hold time in queue position announcements.
LocationType: Type of service location for an LNP port.
MaxMembers: A conference member cap, or unlimited.
MessageType: Direction of an SMS / MMS message: a filter on requests, the direction on results.
Nat: Asterisk NAT handling mode.
PlayInstructions: Voicemail playback instruction mode.
QueueEmptyBehavior: Whether callers may join, or are kept in, a queue with no available members. Used by both join_when_empty and leave_when_empty.
RecordingSort: Sort order for selected recordings.
RingGroupOrder: Order in which ring-group members are attempted.
RingStrategy: Queue ring strategy. Mirrors Asterisk’s queue strategy options.
Routing: A VoIP.ms routing target encoded on the wire as tag:payload.
RoutingParseError: Error from parsing a Routing from a string.
SearchType: How a DID / toll-free search string is matched.
Seconds: A duration in seconds, or an “unbounded” sentinel.
TimezoneName: A named time zone as VoIP.ms reports it: a parsed chrono_tz::Tz when the bundled IANA database recognizes the name, or the verbatim wire string when it does not.
TimezoneOffsetError: Error from constructing a TimezoneOffset.
TollFreeCarrier: Carrier for outgoing calls to toll-free numbers.
TranscriptionFormat: Voicemail transcription output format.
VanityType: Toll-free prefix to search for a vanity number.
VoicemailFolder: Voicemail message folder.
WaitTime: A wait time in seconds, or unlimited.

Constants§

DEFAULT_BASE_URL: Default base URL for the VoIP.ms REST API.

Type Aliases§

Result: Result type returned by all Client methods.

Crate voip_ms

Crate voip_ms Copy item path

§Quick start

§Design

§Authentication

§IP allow-listing

§Wire format

Re-exports§

Structs§

Enums§

Constants§

Type Aliases§

Crate voip_ms