LookupResult.md

LookupResult

Carrier information results for the specified telephone number.

Properties

Name	Type	Description	Notes
phoneNumber	string	The telephone number in E.164 format.	[optional] [default to undefined]
lineType	LineTypeEnum		[optional] [default to undefined]
messagingProvider	string	The messaging service provider of the telephone number.	[optional] [default to undefined]
voiceProvider	string	The voice service provider of the telephone number.	[optional] [default to undefined]
countryCodeA3	string	The country code of the telephone number in ISO 3166-1 alpha-3 format.	[optional] [default to undefined]
deactivationReporter	string	DNI-Only. The carrier that reported a deactivation event for this phone number.	[optional] [default to undefined]
deactivationDate	string	DNI-Only. The datetime the carrier reported a deactivation event.	[optional] [default to undefined]
deactivationEvent	DeactivationEventEnum		[optional] [default to undefined]
latestMessageDeliveryStatus	LatestMessageDeliveryStatusEnum		[optional] [default to undefined]
initialMessageDeliveryStatusDate	string	DNI-Only. The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the "start time" for that status. Value resets every time the `latestMessageDeliveryStatus` changes.	[optional] [default to undefined]
latestMessageDeliveryStatusDate	string	DNI-Only. The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes.	[optional] [default to undefined]
rcsEnabled	boolean	RCS-Only. Indicates whether the phone number is capable of receiving RCS messages. Value will be null if account has RCS, but no value was returned. Absent when account does not have RCS.	[optional] [default to undefined]

Example

import { LookupResult } from 'bandwidth-sdk';

const instance: LookupResult = {
    phoneNumber,
    lineType,
    messagingProvider,
    voiceProvider,
    countryCodeA3,
    deactivationReporter,
    deactivationDate,
    deactivationEvent,
    latestMessageDeliveryStatus,
    initialMessageDeliveryStatusDate,
    latestMessageDeliveryStatusDate,
    rcsEnabled,
};

[Back to Model list] [Back to API list] [Back to README]