Skip to content

MailSlurp\PhoneControllerApi

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

Method HTTP request Description
CreateEmergencyAddress Post /phone/emergency-addresses
DeleteEmergencyAddress Delete /phone/emergency-addresses/{addressId}
DeletePhoneNumber Delete /phone/numbers/{phoneNumberId}
GetEmergencyAddress Get /phone/emergency-addresses/{addressId}
GetEmergencyAddresses Get /phone/emergency-addresses
GetPhoneNumber Get /phone/numbers/{phoneNumberId}
GetPhoneNumbers Get /phone/numbers
GetPhonePlans Get /phone/plans
TestPhoneNumberSendSms Post /phone/numbers/{phoneNumberId}/test

CreateEmergencyAddress

EmergencyAddress CreateEmergencyAddress(ctx, createEmergencyAddressOptions)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createEmergencyAddressOptions CreateEmergencyAddressOptions

Return type

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 ]

DeleteEmergencyAddress

EmptyResponseDto DeleteEmergencyAddress(ctx, addressId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
addressId string

Return type

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 ]

DeletePhoneNumber

DeletePhoneNumber(ctx, phoneNumberId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
phoneNumberId string

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 ]

GetEmergencyAddress

EmergencyAddress GetEmergencyAddress(ctx, addressId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
addressId string

Return type

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 ]

GetEmergencyAddresses

[]EmergencyAddressDto GetEmergencyAddresses(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]EmergencyAddressDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetPhoneNumber

PhoneNumberDto GetPhoneNumber(ctx, phoneNumberId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
phoneNumberId string

Return type

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 ]

GetPhoneNumbers

PagePhoneNumberProjection GetPhoneNumbers(ctx, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetPhoneNumbersOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetPhoneNumbersOpts struct

Name Type Description Notes
phoneCountry optional.String Optional phone country
page optional.Int32 Optional page for list pagination [default to 0]
size optional.Int32 Optional page size for list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

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 ]

GetPhonePlans

[]PhonePlanDto GetPhonePlans(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]PhonePlanDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

TestPhoneNumberSendSms

TestPhoneNumberSendSms(ctx, phoneNumberId, testPhoneNumberOptions, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
phoneNumberId string
testPhoneNumberOptions TestPhoneNumberOptions
optional *TestPhoneNumberSendSmsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a TestPhoneNumberSendSmsOpts struct

Name Type Description Notes

xTestId | optional.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 ]