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 allow-list the IP address you’ll be calling from.

Structs§

AddChargeParams: Parameters for Client::add_charge (wire method addCharge).
AddChargeResponse: Response body for Client::add_charge (wire method addCharge).
AddLNPFileParams: Parameters for Client::add_lnp_file (wire method addLNPFile).
AddLNPFileResponse: Response body for Client::add_lnp_file (wire method addLNPFile).
AddLNPPortParams: Parameters for Client::add_lnp_port (wire method addLNPPort).
AddLNPPortResponse: Response body for Client::add_lnp_port (wire method addLNPPort).
AddMemberToConferenceParams: Parameters for Client::add_member_to_conference (wire method addMemberToConference).
AddMemberToConferenceResponse: Response body for Client::add_member_to_conference (wire method addMemberToConference).
AddPaymentParams: Parameters for Client::add_payment (wire method addPayment).
AddPaymentResponse: Response body for Client::add_payment (wire method addPayment).
ApiStatus: A non-success status returned by the voip.ms API.
AssignDIDvPRIParams: Parameters for Client::assign_did_vpri (wire method assignDIDvPRI).
AssignDIDvPRIResponse: Response body for Client::assign_did_vpri (wire method assignDIDvPRI).
BackOrderDIDCANParams: Parameters for Client::back_order_did_can (wire method backOrderDIDCAN).
BackOrderDIDCANResponse: Response body for Client::back_order_did_can (wire method backOrderDIDCAN).
BackOrderDIDUSAParams: Parameters for Client::back_order_did_usa (wire method backOrderDIDUSA).
BackOrderDIDUSAResponse: Response body for Client::back_order_did_usa (wire method backOrderDIDUSA).
CancelDIDParams: Parameters for Client::cancel_did (wire method cancelDID).
CancelDIDResponse: Response body for Client::cancel_did (wire method cancelDID).
CancelFAXNumberParams: Parameters for Client::cancel_fax_number (wire method cancelFaxNumber).
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: Parameters for Client::connect_did (wire method connectDID).
ConnectDIDResponse: Response body for Client::connect_did (wire method connectDID).
ConnectFAXParams: Parameters for Client::connect_fax (wire method connectFAX).
ConnectFAXResponse: Response body for Client::connect_fax (wire method connectFAX).
CreateSubAccountParams: Parameters for Client::create_sub_account (wire method createSubAccount).
CreateSubAccountResponse: Response body for Client::create_sub_account (wire method createSubAccount).
CreateVoicemailParams: Parameters for Client::create_voicemail (wire method createVoicemail).
CreateVoicemailResponse: Response body for Client::create_voicemail (wire method createVoicemail).
DelCallHuntingParams: Parameters for Client::del_call_hunting (wire method delCallHunting).
DelCallHuntingResponse: Response body for Client::del_call_hunting (wire method delCallHunting).
DelCallParkingParams: Parameters for Client::del_call_parking (wire method delCallParking).
DelCallParkingResponse: Response body for Client::del_call_parking (wire method delCallParking).
DelCallRecordingParams: Parameters for Client::del_call_recording (wire method delCallRecording).
DelCallRecordingResponse: Response body for Client::del_call_recording (wire method delCallRecording).
DelCallbackParams: Parameters for Client::del_callback (wire method delCallback).
DelCallbackResponse: Response body for Client::del_callback (wire method delCallback).
DelCallerIDFilteringParams: Parameters for Client::del_caller_id_filtering (wire method delCallerIDFiltering).
DelCallerIDFilteringResponse: Response body for Client::del_caller_id_filtering (wire method delCallerIDFiltering).
DelClientParams: Parameters for Client::del_client (wire method delClient).
DelClientResponse: Response body for Client::del_client (wire method delClient).
DelConferenceMemberParams: Parameters for Client::del_conference_member (wire method delConferenceMember).
DelConferenceMemberResponse: Response body for Client::del_conference_member (wire method delConferenceMember).
DelConferenceParams: Parameters for Client::del_conference (wire method delConference).
DelConferenceResponse: Response body for Client::del_conference (wire method delConference).
DelDISAParams: Parameters for Client::del_disa (wire method delDISA).
DelDISAResponse: Response body for Client::del_disa (wire method delDISA).
DelEmailToFAXParams: Parameters for Client::del_email_to_fax (wire method delEmailToFax).
DelEmailToFAXResponse: Response body for Client::del_email_to_fax (wire method delEmailToFax).
DelFAXFolderParams: Parameters for Client::del_fax_folder (wire method delFaxFolder).
DelFAXFolderResponse: Response body for Client::del_fax_folder (wire method delFaxFolder).
DelForwardingParams: Parameters for Client::del_forwarding (wire method delForwarding).
DelForwardingResponse: Response body for Client::del_forwarding (wire method delForwarding).
DelIVRParams: Parameters for Client::del_ivr (wire method delIVR).
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: Parameters for Client::del_member_from_conference (wire method delMemberFromConference).
DelMemberFromConferenceResponse: Response body for Client::del_member_from_conference (wire method delMemberFromConference).
DelMessagesParams: Parameters for Client::del_messages (wire method delMessages).
DelMessagesResponse: Response body for Client::del_messages (wire method delMessages).
DelMusicOnHoldParams: Parameters for Client::del_music_on_hold (wire method delMusicOnHold).
DelMusicOnHoldResponse: Response body for Client::del_music_on_hold (wire method delMusicOnHold).
DelPhonebookGroupParams: Parameters for Client::del_phonebook_group (wire method delPhonebookGroup).
DelPhonebookGroupResponse: Response body for Client::del_phonebook_group (wire method delPhonebookGroup).
DelPhonebookParams: Parameters for Client::del_phonebook (wire method delPhonebook).
DelPhonebookResponse: Response body for Client::del_phonebook (wire method delPhonebook).
DelQueueParams: Parameters for Client::del_queue (wire method delQueue).
DelQueueResponse: Response body for Client::del_queue (wire method delQueue).
DelRecordingParams: Parameters for Client::del_recording (wire method delRecording).
DelRecordingResponse: Response body for Client::del_recording (wire method delRecording).
DelRingGroupParams: Parameters for Client::del_ring_group (wire method delRingGroup).
DelRingGroupResponse: Response body for Client::del_ring_group (wire method delRingGroup).
DelSIPURIParams: Parameters for Client::del_sip_uri (wire method delSIPURI).
DelSIPURIResponse: Response body for Client::del_sip_uri (wire method delSIPURI).
DelStaticMemberParams: Parameters for Client::del_static_member (wire method delStaticMember).
DelStaticMemberResponse: Response body for Client::del_static_member (wire method delStaticMember).
DelSubAccountParams: Parameters for Client::del_sub_account (wire method delSubAccount).
DelSubAccountResponse: Response body for Client::del_sub_account (wire method delSubAccount).
DelTimeConditionParams: Parameters for Client::del_time_condition (wire method delTimeCondition).
DelTimeConditionResponse: Response body for Client::del_time_condition (wire method delTimeCondition).
DelVoicemailParams: Parameters for Client::del_voicemail (wire method delVoicemail).
DelVoicemailResponse: Response body for Client::del_voicemail (wire method delVoicemail).
DeleteFAXMessageParams: Parameters for Client::delete_fax_message (wire method deleteFaxMessage).
DeleteFAXMessageResponse: Response body for Client::delete_fax_message (wire method deleteFaxMessage).
DeleteMMSParams: Parameters for Client::delete_mms (wire method deleteMMS).
DeleteMMSResponse: Response body for Client::delete_mms (wire method deleteMMS).
DeleteSMSParams: Parameters for Client::delete_sms (wire method deleteSMS).
DeleteSMSResponse: Response body for Client::delete_sms (wire method deleteSMS).
E911AddressTypesParams: Parameters for Client::e911_address_types (wire method e911AddressTypes).
E911AddressTypesResponse: Response body for Client::e911_address_types (wire method e911AddressTypes).
E911CancelParams: Parameters for Client::e911_cancel (wire method e911Cancel).
E911CancelResponse: Response body for Client::e911_cancel (wire method e911Cancel).
E911InfoParams: Parameters for Client::e911_info (wire method e911Info).
E911InfoResponse: Response body for Client::e911_info (wire method e911Info).
E911ProvisionManuallyParams: Parameters for Client::e911_provision_manually (wire method e911ProvisionManually).
E911ProvisionManuallyResponse: Response body for Client::e911_provision_manually (wire method e911ProvisionManually).
E911ProvisionParams: Parameters for Client::e911_provision (wire method e911Provision).
E911ProvisionResponse: Response body for Client::e911_provision (wire method e911Provision).
E911UpdateParams: Parameters for Client::e911_update (wire method e911Update).
E911UpdateResponse: Response body for Client::e911_update (wire method e911Update).
E911ValidateParams: Parameters for Client::e911_validate (wire method e911Validate).
E911ValidateResponse: Response body for Client::e911_validate (wire method e911Validate).
GetAllowedCodecsParams: Parameters for Client::get_allowed_codecs (wire method getAllowedCodecs).
GetAllowedCodecsResponse
GetAllowedCodecsResponseAllowedCodec: Response body for Client::get_allowed_codecs (wire method getAllowedCodecs).
GetAuthTypesParams: Parameters for Client::get_auth_types (wire method getAuthTypes).
GetAuthTypesResponse
GetAuthTypesResponseAuthType: Response body for Client::get_auth_types (wire method getAuthTypes).
GetBackOrdersParams: Parameters for Client::get_back_orders (wire method getBackOrders).
GetBackOrdersResponse
GetBackOrdersResponseBackOrder: Response body for Client::get_back_orders (wire method getBackOrders).
GetBalanceManagementParams: Parameters for Client::get_balance_management (wire method getBalanceManagement).
GetBalanceManagementResponse
GetBalanceManagementResponseBalanceManagement: Response body for Client::get_balance_management (wire method getBalanceManagement).
GetBalanceParams: Parameters for Client::get_balance (wire method getBalance).
GetBalanceResponse
GetBalanceResponseBalance: Response body for Client::get_balance (wire method getBalance).
GetCDRParams: Parameters for Client::get_cdr (wire method getCDR).
GetCDRResponse
GetCDRResponseCDR: Response body for Client::get_cdr (wire method getCDR).
GetCallAccountsParams: Parameters for Client::get_call_accounts (wire method getCallAccounts).
GetCallAccountsResponse
GetCallAccountsResponseAccount: Response body for Client::get_call_accounts (wire method getCallAccounts).
GetCallBillingParams: Parameters for Client::get_call_billing (wire method getCallBilling).
GetCallBillingResponse
GetCallBillingResponseCallBilling: Response body for Client::get_call_billing (wire method getCallBilling).
GetCallHuntingsParams: Parameters for Client::get_call_huntings (wire method getCallHuntings).
GetCallHuntingsResponse
GetCallHuntingsResponseCallHunting: Response body for Client::get_call_huntings (wire method getCallHuntings).
GetCallParkingParams: Parameters for Client::get_call_parking (wire method getCallParking).
GetCallParkingResponse
GetCallParkingResponseCallHunting: Response body for Client::get_call_parking (wire method getCallParking).
GetCallRecordingParams: Parameters for Client::get_call_recording (wire method getCallRecording).
GetCallRecordingResponse: Response body for Client::get_call_recording (wire method getCallRecording).
GetCallRecordingsParams: Parameters for Client::get_call_recordings (wire method getCallRecordings).
GetCallRecordingsResponse
GetCallRecordingsResponseRecording: Response body for Client::get_call_recordings (wire method getCallRecordings).
GetCallTranscriptionsParams: Parameters for Client::get_call_transcriptions (wire method getCallTranscriptions).
GetCallTranscriptionsResponse
GetCallTranscriptionsResponseTranscription
GetCallTranscriptionsResponseTranscriptionRecognizedPhrase: Response body for Client::get_call_transcriptions (wire method getCallTranscriptions).
GetCallTypesParams: Parameters for Client::get_call_types (wire method getCallTypes).
GetCallTypesResponse
GetCallTypesResponseCallType: Response body for Client::get_call_types (wire method getCallTypes).
GetCallbacksParams: Parameters for Client::get_callbacks (wire method getCallbacks).
GetCallbacksResponse
GetCallbacksResponseCallback: Response body for Client::get_callbacks (wire method getCallbacks).
GetCallerIDFilteringParams: Parameters for Client::get_caller_id_filtering (wire method getCallerIDFiltering).
GetCallerIDFilteringResponse
GetCallerIDFilteringResponseFiltering: Response body for Client::get_caller_id_filtering (wire method getCallerIDFiltering).
GetCarriersParams: Parameters for Client::get_carriers (wire method getCarriers).
GetCarriersResponse
GetCarriersResponseCarrier: Response body for Client::get_carriers (wire method getCarriers).
GetChargesParams: Parameters for Client::get_charges (wire method getCharges).
GetChargesResponse
GetChargesResponseCharge: Response body for Client::get_charges (wire method getCharges).
GetClientPackagesParams: Parameters for Client::get_client_packages (wire method getClientPackages).
GetClientPackagesResponse
GetClientPackagesResponsePackage: Response body for Client::get_client_packages (wire method getClientPackages).
GetClientThresholdParams: Parameters for Client::get_client_threshold (wire method getClientThreshold).
GetClientThresholdResponse
GetClientThresholdResponseThresholdInformation: Response body for Client::get_client_threshold (wire method getClientThreshold).
GetClientsParams: Parameters for Client::get_clients (wire method getClients).
GetClientsResponse
GetClientsResponseClient: Response body for Client::get_clients (wire method getClients).
GetConferenceMembersParams: Parameters for Client::get_conference_members (wire method getConferenceMembers).
GetConferenceMembersResponse
GetConferenceMembersResponseMember: Response body for Client::get_conference_members (wire method getConferenceMembers).
GetConferenceParams: Parameters for Client::get_conference (wire method getConference).
GetConferenceRecordingFileParams: Parameters for Client::get_conference_recording_file (wire method getConferenceRecordingFile).
GetConferenceRecordingFileResponse
GetConferenceRecordingFileResponseRecording: Response body for Client::get_conference_recording_file (wire method getConferenceRecordingFile).
GetConferenceRecordingsParams: Parameters for Client::get_conference_recordings (wire method getConferenceRecordings).
GetConferenceRecordingsResponse
GetConferenceRecordingsResponseRecording: Response body for Client::get_conference_recordings (wire method getConferenceRecordings).
GetConferenceResponse
GetConferenceResponseConference: Response body for Client::get_conference (wire method getConference).
GetCountriesParams: Parameters for Client::get_countries (wire method getCountries).
GetCountriesResponse
GetCountriesResponseCountry: Response body for Client::get_countries (wire method getCountries).
GetDIDCountriesParams: Parameters for Client::get_did_countries (wire method getDIDCountries).
GetDIDCountriesResponse
GetDIDCountriesResponseCountry: Response body for Client::get_did_countries (wire method getDIDCountries).
GetDIDsCANParams: Parameters for Client::get_dids_can (wire method getDIDsCAN).
GetDIDsCANResponse
GetDIDsCANResponseDID: Response body for Client::get_dids_can (wire method getDIDsCAN).
GetDIDsInfoParams: Parameters for Client::get_dids_info (wire method getDIDsInfo).
GetDIDsInfoResponse
GetDIDsInfoResponseDID: Response body for Client::get_dids_info (wire method getDIDsInfo).
GetDIDsInternationalGeographicParams: Parameters for Client::get_dids_international_geographic (wire method getDIDsInternationalGeographic).
GetDIDsInternationalGeographicResponse
GetDIDsInternationalGeographicResponseLocation: Response body for Client::get_dids_international_geographic (wire method getDIDsInternationalGeographic).
GetDIDsInternationalNationalParams: Parameters for Client::get_dids_international_national (wire method getDIDsInternationalNational).
GetDIDsInternationalNationalResponse
GetDIDsInternationalNationalResponseLocation: Response body for Client::get_dids_international_national (wire method getDIDsInternationalNational).
GetDIDsInternationalTollFreeParams: Parameters for Client::get_dids_international_toll_free (wire method getDIDsInternationalTollFree).
GetDIDsInternationalTollFreeResponse
GetDIDsInternationalTollFreeResponseLocation: Response body for Client::get_dids_international_toll_free (wire method getDIDsInternationalTollFree).
GetDIDsUSAParams: Parameters for Client::get_dids_usa (wire method getDIDsUSA).
GetDIDsUSAResponse
GetDIDsUSAResponseDID: Response body for Client::get_dids_usa (wire method getDIDsUSA).
GetDIDvPRIParams: Parameters for Client::get_did_vpri (wire method getDIDvPRI).
GetDIDvPRIResponse: Response body for Client::get_did_vpri (wire method getDIDvPRI).
GetDISAsParams: Parameters for Client::get_disas (wire method getDISAs).
GetDISAsResponse
GetDISAsResponseDISA: Response body for Client::get_disas (wire method getDISAs).
GetDTMFModesParams: Parameters for Client::get_dtmf_modes (wire method getDTMFModes).
GetDTMFModesResponse
GetDTMFModesResponseDTMFMode: Response body for Client::get_dtmf_modes (wire method getDTMFModes).
GetDepositsParams: Parameters for Client::get_deposits (wire method getDeposits).
GetDepositsResponse
GetDepositsResponseDeposit: Response body for Client::get_deposits (wire method getDeposits).
GetDeviceTypesParams: Parameters for Client::get_device_types (wire method getDeviceTypes).
GetDeviceTypesResponse
GetDeviceTypesResponseDeviceType: Response body for Client::get_device_types (wire method getDeviceTypes).
GetEmailToFAXParams: Parameters for Client::get_email_to_fax (wire method getEmailToFax).
GetEmailToFAXResponse
GetEmailToFAXResponseEmailToFAX: Response body for Client::get_email_to_fax (wire method getEmailToFax).
GetFAXFoldersParams: Parameters for Client::get_fax_folders (wire method getFaxFolders).
GetFAXFoldersResponse
GetFAXFoldersResponseFolder: Response body for Client::get_fax_folders (wire method getFaxFolders).
GetFAXMessagePDFParams: Parameters for Client::get_fax_message_pdf (wire method getFaxMessagePDF).
GetFAXMessagePDFResponse: Response body for Client::get_fax_message_pdf (wire method getFaxMessagePDF).
GetFAXMessagesParams: Parameters for Client::get_fax_messages (wire method getFaxMessages).
GetFAXMessagesResponse
GetFAXMessagesResponseFAX: Response body for Client::get_fax_messages (wire method getFaxMessages).
GetFAXNumbersInfoParams: Parameters for Client::get_fax_numbers_info (wire method getFaxNumbersInfo).
GetFAXNumbersInfoResponse
GetFAXNumbersInfoResponseNumber: Response body for Client::get_fax_numbers_info (wire method getFaxNumbersInfo).
GetFAXNumbersPortabilityParams: Parameters for Client::get_fax_numbers_portability (wire method getFaxNumbersPortability).
GetFAXNumbersPortabilityResponse: Response body for Client::get_fax_numbers_portability (wire method getFaxNumbersPortability).
GetFAXProvincesParams: Parameters for Client::get_fax_provinces (wire method getFaxProvinces).
GetFAXProvincesResponse
GetFAXProvincesResponseProvince: Response body for Client::get_fax_provinces (wire method getFaxProvinces).
GetFAXRateCentersCANParams: Parameters for Client::get_fax_rate_centers_can (wire method getFaxRateCentersCAN).
GetFAXRateCentersCANResponse
GetFAXRateCentersCANResponseRatecenter: Response body for Client::get_fax_rate_centers_can (wire method getFaxRateCentersCAN).
GetFAXRateCentersUSAParams: Parameters for Client::get_fax_rate_centers_usa (wire method getFaxRateCentersUSA).
GetFAXRateCentersUSAResponse
GetFAXRateCentersUSAResponseRatecenter: Response body for Client::get_fax_rate_centers_usa (wire method getFaxRateCentersUSA).
GetFAXStatesParams: Parameters for Client::get_fax_states (wire method getFaxStates).
GetFAXStatesResponse
GetFAXStatesResponseState: Response body for Client::get_fax_states (wire method getFaxStates).
GetForwardingsParams: Parameters for Client::get_forwardings (wire method getForwardings).
GetForwardingsResponse
GetForwardingsResponseForwarding: Response body for Client::get_forwardings (wire method getForwardings).
GetIPParams: Parameters for Client::get_ip (wire method getIP).
GetIPResponse: Response body for Client::get_ip (wire method getIP).
GetIVRsParams: Parameters for Client::get_ivrs (wire method getIVRs).
GetIVRsResponse
GetIVRsResponseIVR: Response body for Client::get_ivrs (wire method getIVRs).
GetInternationalTypesParams: Parameters for Client::get_international_types (wire method getInternationalTypes).
GetInternationalTypesResponse
GetInternationalTypesResponseType: Response body for Client::get_international_types (wire method getInternationalTypes).
GetJoinWhenEmptyTypesParams: Parameters for Client::get_join_when_empty_types (wire method getJoinWhenEmptyTypes).
GetJoinWhenEmptyTypesResponse
GetJoinWhenEmptyTypesResponseType: Response body for Client::get_join_when_empty_types (wire method getJoinWhenEmptyTypes).
GetLNPAttachListParams: Parameters for Client::get_lnp_attach_list (wire method getLNPAttachList).
GetLNPAttachListResponse: Response body for Client::get_lnp_attach_list (wire method getLNPAttachList).
GetLNPAttachParams: Parameters for Client::get_lnp_attach (wire method getLNPAttach).
GetLNPAttachResponse: Response body for Client::get_lnp_attach (wire method getLNPAttach).
GetLNPDetailsParams: Parameters for Client::get_lnp_details (wire method getLNPDetails).
GetLNPDetailsResponse
GetLNPDetailsResponseAttachment
GetLNPDetailsResponseNote
GetLNPDetailsResponseNumber: Response body for Client::get_lnp_details (wire method getLNPDetails).
GetLNPListParams: Parameters for Client::get_lnp_list (wire method getLNPList).
GetLNPListResponse: Response body for Client::get_lnp_list (wire method getLNPList).
GetLNPListStatusParams: Parameters for Client::get_lnp_list_status (wire method getLNPListStatus).
GetLNPListStatusResponse: Response body for Client::get_lnp_list_status (wire method getLNPListStatus).
GetLNPNotesParams: Parameters for Client::get_lnp_notes (wire method getLNPNotes).
GetLNPNotesResponse: Response body for Client::get_lnp_notes (wire method getLNPNotes).
GetLNPStatusParams: Parameters for Client::get_lnp_status (wire method getLNPStatus).
GetLNPStatusResponse: Response body for Client::get_lnp_status (wire method getLNPStatus).
GetLanguagesParams: Parameters for Client::get_languages (wire method getLanguages).
GetLanguagesResponse
GetLanguagesResponseLanguage: Response body for Client::get_languages (wire method getLanguages).
GetLocalesParams: Parameters for Client::get_locales (wire method getLocales).
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: Parameters for Client::get_lock_international (wire method getLockInternational).
GetLockInternationalResponse
GetLockInternationalResponseLockInternational: Response body for Client::get_lock_international (wire method getLockInternational).
GetMMSParams: Parameters for Client::get_mms (wire method getMMS).
GetMMSResponse
GetMMSResponseSMS: Response body for Client::get_mms (wire method getMMS).
GetMediaMMSParams: Parameters for Client::get_media_mms (wire method getMediaMMS).
GetMediaMMSResponse: Response body for Client::get_media_mms (wire method getMediaMMS).
GetMusicOnHoldParams: Parameters for Client::get_music_on_hold (wire method getMusicOnHold).
GetMusicOnHoldResponse
GetMusicOnHoldResponseMusicOnHold: Response body for Client::get_music_on_hold (wire method getMusicOnHold).
GetNATParams: Parameters for Client::get_nat (wire method getNAT).
GetNATResponse: Response body for Client::get_nat (wire method getNAT).
GetPackagesParams: Parameters for Client::get_packages (wire method getPackages).
GetPackagesResponse
GetPackagesResponsePackage: Response body for Client::get_packages (wire method getPackages).
GetPhonebookGroupsParams: Parameters for Client::get_phonebook_groups (wire method getPhonebookGroups).
GetPhonebookGroupsResponse
GetPhonebookGroupsResponsePhonebook: Response body for Client::get_phonebook_groups (wire method getPhonebookGroups).
GetPhonebookParams: Parameters for Client::get_phonebook (wire method getPhonebook).
GetPhonebookResponse
GetPhonebookResponsePhonebook: Response body for Client::get_phonebook (wire method getPhonebook).
GetPlayInstructionsParams: Parameters for Client::get_play_instructions (wire method getPlayInstructions).
GetPlayInstructionsResponse: Response body for Client::get_play_instructions (wire method getPlayInstructions).
GetPortabilityParams: Parameters for Client::get_portability (wire method getPortability).
GetPortabilityResponse
GetPortabilityResponsePlan: Response body for Client::get_portability (wire method getPortability).
GetProtocolsParams: Parameters for Client::get_protocols (wire method getProtocols).
GetProtocolsResponse
GetProtocolsResponseProtocol: Response body for Client::get_protocols (wire method getProtocols).
GetProvincesParams: Parameters for Client::get_provinces (wire method getProvinces).
GetProvincesResponse
GetProvincesResponseProvince: Response body for Client::get_provinces (wire method getProvinces).
GetQueuesParams: Parameters for Client::get_queues (wire method getQueues).
GetQueuesResponse
GetQueuesResponseQueue: Response body for Client::get_queues (wire method getQueues).
GetRateCentersCANParams: Parameters for Client::get_rate_centers_can (wire method getRateCentersCAN).
GetRateCentersCANResponse
GetRateCentersCANResponseRatecenter: Response body for Client::get_rate_centers_can (wire method getRateCentersCAN).
GetRateCentersUSAParams: Parameters for Client::get_rate_centers_usa (wire method getRateCentersUSA).
GetRateCentersUSAResponse
GetRateCentersUSAResponseRatecenter: Response body for Client::get_rate_centers_usa (wire method getRateCentersUSA).
GetRatesParams: Parameters for Client::get_rates (wire method getRates).
GetRatesResponse
GetRatesResponseRate: Response body for Client::get_rates (wire method getRates).
GetRecordingFileParams: Parameters for Client::get_recording_file (wire method getRecordingFile).
GetRecordingFileResponse
GetRecordingFileResponseRecording: Response body for Client::get_recording_file (wire method getRecordingFile).
GetRecordingsParams: Parameters for Client::get_recordings (wire method getRecordings).
GetRecordingsResponse
GetRecordingsResponseRecording: Response body for Client::get_recordings (wire method getRecordings).
GetRegistrationStatusParams: Parameters for Client::get_registration_status (wire method getRegistrationStatus).
GetRegistrationStatusResponse
GetRegistrationStatusResponseRegistration: Response body for Client::get_registration_status (wire method getRegistrationStatus).
GetReportEstimatedHoldTimeParams: Parameters for Client::get_report_estimated_hold_time (wire method getReportEstimatedHoldTime).
GetReportEstimatedHoldTimeResponse
GetReportEstimatedHoldTimeResponseType: Response body for Client::get_report_estimated_hold_time (wire method getReportEstimatedHoldTime).
GetResellerBalanceParams: Parameters for Client::get_reseller_balance (wire method getResellerBalance).
GetResellerBalanceResponse
GetResellerBalanceResponseBalance: Response body for Client::get_reseller_balance (wire method getResellerBalance).
GetResellerCDRParams: Parameters for Client::get_reseller_cdr (wire method getResellerCDR).
GetResellerCDRResponse
GetResellerCDRResponseCDR: Response body for Client::get_reseller_cdr (wire method getResellerCDR).
GetResellerMMSParams: Parameters for Client::get_reseller_mms (wire method getResellerMMS).
GetResellerMMSResponse
GetResellerMMSResponseSMS: Response body for Client::get_reseller_mms (wire method getResellerMMS).
GetResellerSMSParams: Parameters for Client::get_reseller_sms (wire method getResellerSMS).
GetResellerSMSResponse
GetResellerSMSResponseSMS: Response body for Client::get_reseller_sms (wire method getResellerSMS).
GetRingGroupsParams: Parameters for Client::get_ring_groups (wire method getRingGroups).
GetRingGroupsResponse
GetRingGroupsResponseRingGroup: Response body for Client::get_ring_groups (wire method getRingGroups).
GetRingStrategiesParams: Parameters for Client::get_ring_strategies (wire method getRingStrategies).
GetRingStrategiesResponse
GetRingStrategiesResponseStrategy: Response body for Client::get_ring_strategies (wire method getRingStrategies).
GetRoutesParams: Parameters for Client::get_routes (wire method getRoutes).
GetRoutesResponse
GetRoutesResponseRoute: Response body for Client::get_routes (wire method getRoutes).
GetSIPURIsParams: Parameters for Client::get_sip_uris (wire method getSIPURIs).
GetSIPURIsResponse
GetSIPURIsResponseSIPURI: Response body for Client::get_sip_uris (wire method getSIPURIs).
GetSMSParams: Parameters for Client::get_sms (wire method getSMS).
GetSMSResponse
GetSMSResponseSMS: Response body for Client::get_sms (wire method getSMS).
GetServersInfoParams: Parameters for Client::get_servers_info (wire method getServersInfo).
GetServersInfoResponse
GetServersInfoResponseServer: Response body for Client::get_servers_info (wire method getServersInfo).
GetStatesParams: Parameters for Client::get_states (wire method getStates).
GetStatesResponse
GetStatesResponseState: Response body for Client::get_states (wire method getStates).
GetStaticMembersParams: Parameters for Client::get_static_members (wire method getStaticMembers).
GetStaticMembersResponse
GetStaticMembersResponseMember: Response body for Client::get_static_members (wire method getStaticMembers).
GetSubAccountsParams: Parameters for Client::get_sub_accounts (wire method getSubAccounts).
GetSubAccountsResponse
GetSubAccountsResponseAccount: Response body for Client::get_sub_accounts (wire method getSubAccounts).
GetTerminationRatesParams: Parameters for Client::get_termination_rates (wire method getTerminationRates).
GetTerminationRatesResponse
GetTerminationRatesResponseRate
GetTerminationRatesResponseRoute: Response body for Client::get_termination_rates (wire method getTerminationRates).
GetTimeConditionsParams: Parameters for Client::get_time_conditions (wire method getTimeConditions).
GetTimeConditionsResponse
GetTimeConditionsResponseTimecondition: Response body for Client::get_time_conditions (wire method getTimeConditions).
GetTimezonesParams: Parameters for Client::get_timezones (wire method getTimezones).
GetTimezonesResponse
GetTimezonesResponseTimezone: Response body for Client::get_timezones (wire method getTimezones).
GetTransactionHistoryParams: Parameters for Client::get_transaction_history (wire method getTransactionHistory).
GetTransactionHistoryResponse
GetTransactionHistoryResponseTransaction: Response body for Client::get_transaction_history (wire method getTransactionHistory).
GetVPRIsParams: Parameters for Client::get_vpris (wire method getVPRIs).
GetVPRIsResponse
GetVPRIsResponseVPRI: Response body for Client::get_vpris (wire method getVPRIs).
GetVoicemailAttachmentFormatsParams: Parameters for Client::get_voicemail_attachment_formats (wire method getVoicemailAttachmentFormats).
GetVoicemailAttachmentFormatsResponse
GetVoicemailAttachmentFormatsResponseEmailAttachmentFormat: Response body for Client::get_voicemail_attachment_formats (wire method getVoicemailAttachmentFormats).
GetVoicemailFoldersParams: Parameters for Client::get_voicemail_folders (wire method getVoicemailFolders).
GetVoicemailFoldersResponse
GetVoicemailFoldersResponseFolder: Response body for Client::get_voicemail_folders (wire method getVoicemailFolders).
GetVoicemailMessageFileParams: Parameters for Client::get_voicemail_message_file (wire method getVoicemailMessageFile).
GetVoicemailMessageFileResponse
GetVoicemailMessageFileResponseMessage: Response body for Client::get_voicemail_message_file (wire method getVoicemailMessageFile).
GetVoicemailMessagesParams: Parameters for Client::get_voicemail_messages (wire method getVoicemailMessages).
GetVoicemailMessagesResponse
GetVoicemailMessagesResponseMessage: Response body for Client::get_voicemail_messages (wire method getVoicemailMessages).
GetVoicemailSetupsParams: Parameters for Client::get_voicemail_setups (wire method getVoicemailSetups).
GetVoicemailSetupsResponse
GetVoicemailSetupsResponseVoicemailsetup: Response body for Client::get_voicemail_setups (wire method getVoicemailSetups).
GetVoicemailTranscriptionsParams: Parameters for Client::get_voicemail_transcriptions (wire method getVoicemailTranscriptions).
GetVoicemailTranscriptionsResponse
GetVoicemailTranscriptionsResponseMessage: Response body for Client::get_voicemail_transcriptions (wire method getVoicemailTranscriptions).
GetVoicemailsParams: Parameters for Client::get_voicemails (wire method getVoicemails).
GetVoicemailsResponse
GetVoicemailsResponseVoicemail: Response body for Client::get_voicemails (wire method getVoicemails).
MailFAXMessagePDFParams: Parameters for Client::mail_fax_message_pdf (wire method mailFaxMessagePDF).
MailFAXMessagePDFResponse: Response body for Client::mail_fax_message_pdf (wire method mailFaxMessagePDF).
MarkListenedVoicemailMessageParams: Parameters for Client::mark_listened_voicemail_message (wire method markListenedVoicemailMessage).
MarkListenedVoicemailMessageResponse: Response body for Client::mark_listened_voicemail_message (wire method markListenedVoicemailMessage).
MarkUrgentVoicemailMessageParams: Parameters for Client::mark_urgent_voicemail_message (wire method markUrgentVoicemailMessage).
MarkUrgentVoicemailMessageResponse: Response body for Client::mark_urgent_voicemail_message (wire method markUrgentVoicemailMessage).
MoveFAXMessageParams: Parameters for Client::move_fax_message (wire method moveFaxMessage).
MoveFAXMessageResponse: Response body for Client::move_fax_message (wire method moveFaxMessage).
MoveFolderVoicemailMessageParams: Parameters for Client::move_folder_voicemail_message (wire method moveFolderVoicemailMessage).
MoveFolderVoicemailMessageResponse: Response body for Client::move_folder_voicemail_message (wire method moveFolderVoicemailMessage).
OrderDIDInternationalGeographicParams: Parameters for Client::order_did_international_geographic (wire method orderDIDInternationalGeographic).
OrderDIDInternationalGeographicResponse: Response body for Client::order_did_international_geographic (wire method orderDIDInternationalGeographic).
OrderDIDInternationalNationalParams: Parameters for Client::order_did_international_national (wire method orderDIDInternationalNational).
OrderDIDInternationalNationalResponse: Response body for Client::order_did_international_national (wire method orderDIDInternationalNational).
OrderDIDInternationalTollFreeParams: Parameters for Client::order_did_international_toll_free (wire method orderDIDInternationalTollFree).
OrderDIDInternationalTollFreeResponse: Response body for Client::order_did_international_toll_free (wire method orderDIDInternationalTollFree).
OrderDIDParams: Parameters for Client::order_did (wire method orderDID).
OrderDIDResponse: Response body for Client::order_did (wire method orderDID).
OrderDIDVirtualParams: Parameters for Client::order_did_virtual (wire method orderDIDVirtual).
OrderDIDVirtualResponse: Response body for Client::order_did_virtual (wire method orderDIDVirtual).
OrderFAXNumberParams: Parameters for Client::order_fax_number (wire method orderFaxNumber).
OrderFAXNumberResponse: Response body for Client::order_fax_number (wire method orderFaxNumber).
OrderTollFreeParams: Parameters for Client::order_toll_free (wire method orderTollFree).
OrderTollFreeResponse: Response body for Client::order_toll_free (wire method orderTollFree).
OrderVanityParams: Parameters for Client::order_vanity (wire method orderVanity).
OrderVanityResponse: Response body for Client::order_vanity (wire method orderVanity).
RemoveDIDvPRIParams: Parameters for Client::remove_did_vpri (wire method removeDIDvPRI).
RemoveDIDvPRIResponse: Response body for Client::remove_did_vpri (wire method removeDIDvPRI).
SearchDIDsCANParams: Parameters for Client::search_dids_can (wire method searchDIDsCAN).
SearchDIDsCANResponse
SearchDIDsCANResponseDID: Response body for Client::search_dids_can (wire method searchDIDsCAN).
SearchDIDsUSAParams: Parameters for Client::search_dids_usa (wire method searchDIDsUSA).
SearchDIDsUSAResponse
SearchDIDsUSAResponseDID: Response body for Client::search_dids_usa (wire method searchDIDsUSA).
SearchFAXAreaCodeCANParams: Parameters for Client::search_fax_area_code_can (wire method searchFaxAreaCodeCAN).
SearchFAXAreaCodeCANResponse
SearchFAXAreaCodeCANResponse0: Response body for Client::search_fax_area_code_can (wire method searchFaxAreaCodeCAN).
SearchFAXAreaCodeUSAParams: Parameters for Client::search_fax_area_code_usa (wire method searchFaxAreaCodeUSA).
SearchFAXAreaCodeUSAResponse: Response body for Client::search_fax_area_code_usa (wire method searchFaxAreaCodeUSA).
SearchTollFreeCANUSParams: Parameters for Client::search_toll_free_can_us (wire method searchTollFreeCanUS).
SearchTollFreeCANUSResponse
SearchTollFreeCANUSResponseDID: Response body for Client::search_toll_free_can_us (wire method searchTollFreeCanUS).
SearchTollFreeUSAParams: Parameters for Client::search_toll_free_usa (wire method searchTollFreeUSA).
SearchTollFreeUSAResponse
SearchTollFreeUSAResponseDID: Response body for Client::search_toll_free_usa (wire method searchTollFreeUSA).
SearchVanityParams: Parameters for Client::search_vanity (wire method searchVanity).
SearchVanityResponse
SearchVanityResponseDID: Response body for Client::search_vanity (wire method searchVanity).
SendCallRecordingEmailParams: Parameters for Client::send_call_recording_email (wire method sendCallRecordingEmail).
SendCallRecordingEmailResponse: Response body for Client::send_call_recording_email (wire method sendCallRecordingEmail).
SendFAXMessageParams: Parameters for Client::send_fax_message (wire method sendFaxMessage).
SendFAXMessageResponse: Response body for Client::send_fax_message (wire method sendFaxMessage).
SendMMSParams: Parameters for Client::send_mms (wire method sendMMS).
SendMMSResponse: Response body for Client::send_mms (wire method sendMMS).
SendSMSParams: Parameters for Client::send_sms (wire method sendSMS).
SendSMSResponse: Response body for Client::send_sms (wire method sendSMS).
SendVoicemailEmailParams: Parameters for Client::send_voicemail_email (wire method sendVoicemailEmail).
SendVoicemailEmailResponse: Response body for Client::send_voicemail_email (wire method sendVoicemailEmail).
SetCallHuntingParams: Parameters for Client::set_call_hunting (wire method setCallHunting).
SetCallHuntingResponse: Response body for Client::set_call_hunting (wire method setCallHunting).
SetCallParkingParams: Parameters for Client::set_call_parking (wire method setCallParking).
SetCallParkingResponse: Response body for Client::set_call_parking (wire method setCallParking).
SetCallbackParams: Parameters for Client::set_callback (wire method setCallback).
SetCallbackResponse: Response body for Client::set_callback (wire method setCallback).
SetCallerIDFilteringParams: Parameters for Client::set_caller_id_filtering (wire method setCallerIDFiltering).
SetCallerIDFilteringResponse: Response body for Client::set_caller_id_filtering (wire method setCallerIDFiltering).
SetClientParams: Parameters for Client::set_client (wire method setClient).
SetClientResponse: Response body for Client::set_client (wire method setClient).
SetClientThresholdParams: Parameters for Client::set_client_threshold (wire method setClientThreshold).
SetClientThresholdResponse: Response body for Client::set_client_threshold (wire method setClientThreshold).
SetConferenceMemberParams: Parameters for Client::set_conference_member (wire method setConferenceMember).
SetConferenceMemberResponse: Response body for Client::set_conference_member (wire method setConferenceMember).
SetConferenceParams: Parameters for Client::set_conference (wire method setConference).
SetConferenceResponse: Response body for Client::set_conference (wire method setConference).
SetDIDBillingTypeParams: Parameters for Client::set_did_billing_type (wire method setDIDBillingType).
SetDIDBillingTypeResponse: Response body for Client::set_did_billing_type (wire method setDIDBillingType).
SetDIDInfoParams: Parameters for Client::set_did_info (wire method setDIDInfo).
SetDIDInfoResponse: Response body for Client::set_did_info (wire method setDIDInfo).
SetDIDPOPParams: Parameters for Client::set_did_pop (wire method setDIDPOP).
SetDIDPOPResponse: Response body for Client::set_did_pop (wire method setDIDPOP).
SetDIDRoutingParams: Parameters for Client::set_did_routing (wire method setDIDRouting).
SetDIDRoutingResponse: Response body for Client::set_did_routing (wire method setDIDRouting).
SetDIDVoicemailParams: Parameters for Client::set_did_voicemail (wire method setDIDVoicemail).
SetDIDVoicemailResponse: Response body for Client::set_did_voicemail (wire method setDIDVoicemail).
SetDISAParams: Parameters for Client::set_disa (wire method setDISA).
SetDISAResponse: Response body for Client::set_disa (wire method setDISA).
SetEmailToFAXParams: Parameters for Client::set_email_to_fax (wire method setEmailToFax).
SetEmailToFAXResponse: Response body for Client::set_email_to_fax (wire method setEmailToFax).
SetFAXFolderParams: Parameters for Client::set_fax_folder (wire method setFaxFolder).
SetFAXFolderResponse: Response body for Client::set_fax_folder (wire method setFaxFolder).
SetFAXNumberEmailParams: Parameters for Client::set_fax_number_email (wire method setFaxNumberEmail).
SetFAXNumberEmailResponse: Response body for Client::set_fax_number_email (wire method setFaxNumberEmail).
SetFAXNumberInfoParams: Parameters for Client::set_fax_number_info (wire method setFaxNumberInfo).
SetFAXNumberInfoResponse: Response body for Client::set_fax_number_info (wire method setFaxNumberInfo).
SetFAXNumberURLCallbackParams: Parameters for Client::set_fax_number_url_callback (wire method setFaxNumberURLCallback).
SetFAXNumberURLCallbackResponse: Response body for Client::set_fax_number_url_callback (wire method setFaxNumberURLCallback).
SetForwardingParams: Parameters for Client::set_forwarding (wire method setForwarding).
SetForwardingResponse: Response body for Client::set_forwarding (wire method setForwarding).
SetIVRParams: Parameters for Client::set_ivr (wire method setIVR).
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: Parameters for Client::set_phonebook_group (wire method setPhonebookGroup).
SetPhonebookGroupResponse: Response body for Client::set_phonebook_group (wire method setPhonebookGroup).
SetPhonebookParams: Parameters for Client::set_phonebook (wire method setPhonebook).
SetPhonebookResponse: Response body for Client::set_phonebook (wire method setPhonebook).
SetQueueParams: Parameters for Client::set_queue (wire method setQueue).
SetQueueResponse: Response body for Client::set_queue (wire method setQueue).
SetRecordingParams: Parameters for Client::set_recording (wire method setRecording).
SetRecordingResponse: Response body for Client::set_recording (wire method setRecording).
SetRingGroupParams: Parameters for Client::set_ring_group (wire method setRingGroup).
SetRingGroupResponse: Response body for Client::set_ring_group (wire method setRingGroup).
SetSIPURIParams: Parameters for Client::set_sip_uri (wire method setSIPURI).
SetSIPURIResponse: Response body for Client::set_sip_uri (wire method setSIPURI).
SetSMSParams: Parameters for Client::set_sms (wire method setSMS).
SetSMSResponse: Response body for Client::set_sms (wire method setSMS).
SetStaticMemberParams: Parameters for Client::set_static_member (wire method setStaticMember).
SetStaticMemberResponse: Response body for Client::set_static_member (wire method setStaticMember).
SetSubAccountParams: Parameters for Client::set_sub_account (wire method setSubAccount).
SetSubAccountResponse: Response body for Client::set_sub_account (wire method setSubAccount).
SetTimeConditionParams: Parameters for Client::set_time_condition (wire method setTimeCondition).
SetTimeConditionResponse: Response body for Client::set_time_condition (wire method setTimeCondition).
SetVoicemailParams: Parameters for Client::set_voicemail (wire method setVoicemail).
SetVoicemailResponse: Response body for Client::set_voicemail (wire method setVoicemail).
SignupClientParams: Parameters for Client::signup_client (wire method signupClient).
SignupClientResponse: Response body for Client::signup_client (wire method signupClient).
UnconnectDIDParams: Parameters for Client::unconnect_did (wire method unconnectDID).
UnconnectDIDResponse: Response body for Client::unconnect_did (wire method unconnectDID).
UnconnectFAXParams: Parameters for Client::unconnect_fax (wire method unconnectFAX).
UnconnectFAXResponse: Response body for Client::unconnect_fax (wire method unconnectFAX).

Enums§

DtmfMode: DTMF transport mode for SIP sub-accounts.
EmailAttachmentFormat: Voicemail email attachment format.
Error: Errors returned by the voip.ms client.
Nat: Asterisk NAT handling mode.
PlayInstructions: Voicemail playback instruction mode.
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.
TranscriptionFormat: Voicemail transcription output format.
VoicemailFolder: Voicemail message folder.

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

Structs§

Enums§

Constants§

Type Aliases§

Crate voip_ms