GET PhoneChannel?phoneNumber={phoneNumber}&shortCode={shortCode}&countryCode={countryCode}

Fetches the first PhoneChannel object that matches the provided information.

Request Information

URI Parameters

Name	Description	Type	Additional information
phoneNumber	Phone Number to search for	string	Required
shortCode	Short code to search for	string	Required
countryCode	Country Code for the phone number	string	Default value is 1

Body Parameters

None.

Response Information

Resource Description

A single PhoneChannel object, if found

PhoneChannel

Name	Type	Additional information
PhoneChannelID	integer	None.
PhoneID	integer	None.
VIPID	globally unique identifier	None.
PhoneNumber	string	None.
CountryCode	string	None.
PhoneChannelStatusTypeID	integer	None.
ShortCodeID	integer	None.
IsActive	boolean	None.
DateCreated	date	None.
DateModified	date	None.

Response Formats

application/json, text/json

Sample:

{
  "phoneChannelID": 1,
  "phoneID": 2,
  "vipid": "738d5133-1333-44c0-8326-29a1014344af",
  "phoneNumber": "sample string 3",
  "countryCode": "sample string 4",
  "phoneChannelStatusTypeID": 5,
  "shortCodeID": 6,
  "isActive": true,
  "dateCreated": "2026-04-21T06:48:52.7097566-04:00",
  "dateModified": "2026-04-21T06:48:52.7097566-04:00"
}

text/html

Sample:

{"phoneChannelID":1,"phoneID":2,"vipid":"738d5133-1333-44c0-8326-29a1014344af","phoneNumber":"sample string 3","countryCode":"sample string 4","phoneChannelStatusTypeID":5,"shortCodeID":6,"isActive":true,"dateCreated":"2026-04-21T06:48:52.7097566-04:00","dateModified":"2026-04-21T06:48:52.7097566-04:00"}

application/xml, text/xml

Sample:

<PhoneChannel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ContactService.Models">
  <CountryCode>sample string 4</CountryCode>
  <DateCreated>2026-04-21T06:48:52.7097566-04:00</DateCreated>
  <DateModified>2026-04-21T06:48:52.7097566-04:00</DateModified>
  <IsActive>true</IsActive>
  <PhoneChannelID>1</PhoneChannelID>
  <PhoneChannelStatusTypeID>5</PhoneChannelStatusTypeID>
  <PhoneID>2</PhoneID>
  <PhoneNumber>sample string 3</PhoneNumber>
  <ShortCodeID>6</ShortCodeID>
  <VIPID>738d5133-1333-44c0-8326-29a1014344af</VIPID>
</PhoneChannel>