POST api/Phone/PhoneDetail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
KeyNum	integer	None.
KeyType	string	None.
SeqNum	integer	None.
DisplayExpiredFlag	boolean	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "KeyNum": 1,
  "KeyType": "sample string 1",
  "SeqNum": 1,
  "DisplayExpiredFlag": true,
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample:

<PhoneListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 4</StagesURL>
  <ApplicationCode>sample string 3</ApplicationCode>
  <SessionNum>2</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DisplayExpiredFlag>true</DisplayExpiredFlag>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 1</KeyType>
  <SeqNum>1</SeqNum>
</PhoneListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PhoneDetailQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of PhoneDetailResult	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "AdditionalDataFlag": true,
      "AutoDialFlag": true,
      "AutoDialMethod": "sample string 1",
      "AutoNotifyFlag": true,
      "Comment": "sample string 2",
      "DataChangeNotifyFlag": true,
      "DayTimeFlag": true,
      "DayTimeNum": 1,
      "Extension": "sample string 3",
      "KeyNum": 1,
      "KeyType": "sample string 4",
      "Phone": "sample string 5",
      "PhoneType": "sample string 6",
      "PhoneTypeDescription": "sample string 7",
      "RefreshContactListsFlag": true,
      "SeqNum": 1,
      "SitePhoneFlag": true,
      "Title": "sample string 8",
      "WorkStationExtension": "sample string 9",
      "ExpiredFlag": true,
      "PhoneStatus": "sample string 10",
      "ActionAutoEvalDescription": "sample string 11",
      "ActionAutoEvalNum": 1,
      "ConfirmedAlarmFlag": true,
      "BadNumberComment": "sample string 12",
      "BadNumberDate": "2025-12-14T17:42:58.4993727-05:00",
      "BadNumberFlag": true,
      "CallDisposition": "sample string 13",
      "CallDispositionDescription": "sample string 14",
      "OverrideEndDate": "2025-12-14T17:42:58.4993727-05:00",
      "OverrideEndTime": "sample string 15",
      "OverridePhone": "sample string 16",
      "OverrideStartDate": "2025-12-14T17:42:58.4993727-05:00",
      "OverrideStartTime": "sample string 17",
      "EffectiveDate": "2025-12-14T17:42:58.4993727-05:00",
      "EffectiveTime": "sample string 18",
      "ExpireDate": "2025-12-14T17:42:58.4993727-05:00",
      "ExpireTime": "sample string 19",
      "PhoneCarrier": "sample string 20",
      "PhoneCarrierDescription": "sample string 21"
    },
    {
      "AdditionalDataFlag": true,
      "AutoDialFlag": true,
      "AutoDialMethod": "sample string 1",
      "AutoNotifyFlag": true,
      "Comment": "sample string 2",
      "DataChangeNotifyFlag": true,
      "DayTimeFlag": true,
      "DayTimeNum": 1,
      "Extension": "sample string 3",
      "KeyNum": 1,
      "KeyType": "sample string 4",
      "Phone": "sample string 5",
      "PhoneType": "sample string 6",
      "PhoneTypeDescription": "sample string 7",
      "RefreshContactListsFlag": true,
      "SeqNum": 1,
      "SitePhoneFlag": true,
      "Title": "sample string 8",
      "WorkStationExtension": "sample string 9",
      "ExpiredFlag": true,
      "PhoneStatus": "sample string 10",
      "ActionAutoEvalDescription": "sample string 11",
      "ActionAutoEvalNum": 1,
      "ConfirmedAlarmFlag": true,
      "BadNumberComment": "sample string 12",
      "BadNumberDate": "2025-12-14T17:42:58.4993727-05:00",
      "BadNumberFlag": true,
      "CallDisposition": "sample string 13",
      "CallDispositionDescription": "sample string 14",
      "OverrideEndDate": "2025-12-14T17:42:58.4993727-05:00",
      "OverrideEndTime": "sample string 15",
      "OverridePhone": "sample string 16",
      "OverrideStartDate": "2025-12-14T17:42:58.4993727-05:00",
      "OverrideStartTime": "sample string 17",
      "EffectiveDate": "2025-12-14T17:42:58.4993727-05:00",
      "EffectiveTime": "sample string 18",
      "ExpireDate": "2025-12-14T17:42:58.4993727-05:00",
      "ExpireTime": "sample string 19",
      "PhoneCarrier": "sample string 20",
      "PhoneCarrierDescription": "sample string 21"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<PhoneDetailQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <PhoneDetailResult>
      <ActionAutoEvalDescription>sample string 11</ActionAutoEvalDescription>
      <ActionAutoEvalNum>1</ActionAutoEvalNum>
      <AdditionalDataFlag>true</AdditionalDataFlag>
      <AutoDialFlag>true</AutoDialFlag>
      <AutoDialMethod>sample string 1</AutoDialMethod>
      <AutoNotifyFlag>true</AutoNotifyFlag>
      <BadNumberComment>sample string 12</BadNumberComment>
      <BadNumberDate>2025-12-14T17:42:58.4993727-05:00</BadNumberDate>
      <BadNumberFlag>true</BadNumberFlag>
      <CallDisposition>sample string 13</CallDisposition>
      <CallDispositionDescription>sample string 14</CallDispositionDescription>
      <Comment>sample string 2</Comment>
      <ConfirmedAlarmFlag>true</ConfirmedAlarmFlag>
      <DataChangeNotifyFlag>true</DataChangeNotifyFlag>
      <DayTimeFlag>true</DayTimeFlag>
      <DayTimeNum>1</DayTimeNum>
      <EffectiveDate>2025-12-14T17:42:58.4993727-05:00</EffectiveDate>
      <EffectiveTime>sample string 18</EffectiveTime>
      <ExpireDate>2025-12-14T17:42:58.4993727-05:00</ExpireDate>
      <ExpireTime>sample string 19</ExpireTime>
      <ExpiredFlag>true</ExpiredFlag>
      <Extension>sample string 3</Extension>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 4</KeyType>
      <OverrideEndDate>2025-12-14T17:42:58.4993727-05:00</OverrideEndDate>
      <OverrideEndTime>sample string 15</OverrideEndTime>
      <OverridePhone>sample string 16</OverridePhone>
      <OverrideStartDate>2025-12-14T17:42:58.4993727-05:00</OverrideStartDate>
      <OverrideStartTime>sample string 17</OverrideStartTime>
      <Phone>sample string 5</Phone>
      <PhoneCarrier>sample string 20</PhoneCarrier>
      <PhoneCarrierDescription>sample string 21</PhoneCarrierDescription>
      <PhoneStatus>sample string 10</PhoneStatus>
      <PhoneType>sample string 6</PhoneType>
      <PhoneTypeDescription>sample string 7</PhoneTypeDescription>
      <RefreshContactListsFlag>true</RefreshContactListsFlag>
      <SeqNum>1</SeqNum>
      <SitePhoneFlag>true</SitePhoneFlag>
      <Title>sample string 8</Title>
      <WorkStationExtension>sample string 9</WorkStationExtension>
    </PhoneDetailResult>
    <PhoneDetailResult>
      <ActionAutoEvalDescription>sample string 11</ActionAutoEvalDescription>
      <ActionAutoEvalNum>1</ActionAutoEvalNum>
      <AdditionalDataFlag>true</AdditionalDataFlag>
      <AutoDialFlag>true</AutoDialFlag>
      <AutoDialMethod>sample string 1</AutoDialMethod>
      <AutoNotifyFlag>true</AutoNotifyFlag>
      <BadNumberComment>sample string 12</BadNumberComment>
      <BadNumberDate>2025-12-14T17:42:58.4993727-05:00</BadNumberDate>
      <BadNumberFlag>true</BadNumberFlag>
      <CallDisposition>sample string 13</CallDisposition>
      <CallDispositionDescription>sample string 14</CallDispositionDescription>
      <Comment>sample string 2</Comment>
      <ConfirmedAlarmFlag>true</ConfirmedAlarmFlag>
      <DataChangeNotifyFlag>true</DataChangeNotifyFlag>
      <DayTimeFlag>true</DayTimeFlag>
      <DayTimeNum>1</DayTimeNum>
      <EffectiveDate>2025-12-14T17:42:58.4993727-05:00</EffectiveDate>
      <EffectiveTime>sample string 18</EffectiveTime>
      <ExpireDate>2025-12-14T17:42:58.4993727-05:00</ExpireDate>
      <ExpireTime>sample string 19</ExpireTime>
      <ExpiredFlag>true</ExpiredFlag>
      <Extension>sample string 3</Extension>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 4</KeyType>
      <OverrideEndDate>2025-12-14T17:42:58.4993727-05:00</OverrideEndDate>
      <OverrideEndTime>sample string 15</OverrideEndTime>
      <OverridePhone>sample string 16</OverridePhone>
      <OverrideStartDate>2025-12-14T17:42:58.4993727-05:00</OverrideStartDate>
      <OverrideStartTime>sample string 17</OverrideStartTime>
      <Phone>sample string 5</Phone>
      <PhoneCarrier>sample string 20</PhoneCarrier>
      <PhoneCarrierDescription>sample string 21</PhoneCarrierDescription>
      <PhoneStatus>sample string 10</PhoneStatus>
      <PhoneType>sample string 6</PhoneType>
      <PhoneTypeDescription>sample string 7</PhoneTypeDescription>
      <RefreshContactListsFlag>true</RefreshContactListsFlag>
      <SeqNum>1</SeqNum>
      <SitePhoneFlag>true</SitePhoneFlag>
      <Title>sample string 8</Title>
      <WorkStationExtension>sample string 9</WorkStationExtension>
    </PhoneDetailResult>
  </ResultSet>
</PhoneDetailQueryResult>