Method: WhatsAppCloudApi::PhoneNumbersController#get_phone_number_by_id

Defined in:
lib/whats_app_cloud_api/controllers/phone_numbers_controller.rb

#get_phone_number_by_id(phone_number_id) ⇒ GetPhoneNumberByIDResponse

When you query all the phone numbers for a WhatsApp Business Account, each phone number has an id. You can directly query for a phone number using this id.

Parameters:

  • phone_number_id (String) —

    Required parameter: Example:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/whats_app_cloud_api/controllers/phone_numbers_controller.rb', line 62

def get_phone_number_by_id(phone_number_id)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/{Phone-Number-ID}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  GetPhoneNumberByIDResponse.from_hash(decoded)
end