Method: Vonage::Numbers#cancel

Defined in:
lib/vonage/numbers.rb

#cancel(params) ⇒ Response

Cancel your subscription for a specific inbound number.

Examples:

response = client.numbers.cancel(country: 'GB', msisdn: '447700900000')

Parameters:

  • params (Hash)

Options Hash (params):

  • :country (required, String) —

    The two character country code in ISO 3166-1 alpha-2 format.

  • :msisdn (required, String) —

    An available inbound virtual number.

  • :target_api_key (String) —

    If you'd like to perform an action on a subaccount, provide the api_key of that account here. If you'd like to perform an action on your own account, you do not need to provide this field.

Returns:

See Also:



159
160
161
162
163
164
165
166
 
# File 'lib/vonage/numbers.rb', line 159

def cancel(params)
  request(
    "/number/cancel",
    params: params,
    type: Post,
    response_class: Response
  )
end