Skip to content

\PhoneControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
create_emergency_address post /phone/emergency-addresses
delete_emergency_address delete /phone/emergency-addresses/{addressId}
delete_phone_number delete /phone/numbers/{phoneNumberId}
get_emergency_address get /phone/emergency-addresses/{addressId}
get_emergency_addresses get /phone/emergency-addresses
get_phone_number get /phone/numbers/{phoneNumberId}
get_phone_numbers get /phone/numbers
get_phone_plans get /phone/plans
test_phone_number_send_sms post /phone/numbers/{phoneNumberId}/test

create_emergency_address

crate::models::EmergencyAddress create_emergency_address(create_emergency_address_options)

Parameters

Name Type Description Required Notes
create_emergency_address_options CreateEmergencyAddressOptions [required]

Return type

crate::models::EmergencyAddress

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_emergency_address

crate::models::EmptyResponseDto delete_emergency_address(address_id)

Parameters

Name Type Description Required Notes
address_id String [required]

Return type

crate::models::EmptyResponseDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_phone_number

delete_phone_number(phone_number_id)

Parameters

Name Type Description Required Notes
phone_number_id String [required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_emergency_address

crate::models::EmergencyAddress get_emergency_address(address_id)

Parameters

Name Type Description Required Notes
address_id String [required]

Return type

crate::models::EmergencyAddress

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_emergency_addresses

Vec get_emergency_addresses()

Parameters

This endpoint does not need any parameter.

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_phone_number

crate::models::PhoneNumberDto get_phone_number(phone_number_id)

Parameters

Name Type Description Required Notes
phone_number_id String [required]

Return type

crate::models::PhoneNumberDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_phone_numbers

crate::models::PagePhoneNumberProjection get_phone_numbers(phone_country, page, size, sort, since, before)

Parameters

Name Type Description Required Notes
phone_country Option<String> Optional phone country
page Option<i32> Optional page for list pagination [default to 0]
size Option<i32> Optional page size for list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PagePhoneNumberProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_phone_plans

Vec get_phone_plans()

Parameters

This endpoint does not need any parameter.

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

test_phone_number_send_sms

test_phone_number_send_sms(phone_number_id, test_phone_number_options, x_test_id)

Parameters

Name Type Description Required Notes
phone_number_id String [required]
test_phone_number_options TestPhoneNumberOptions [required]
x_test_id Option<String>

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]