Reset voicemail password
Version 4.0.0
Endpoint
PATCH
undefined/resource/{id}
Copy
This operation partially updates a Voicemailbox Resource entity by resetting the associated PIN. (TMF 702)
oauth2
Get a JWT Token from AT&T's Azure AD
authorizationCode:
scopes:
tokenUrl:https://login.microsoftonline.com/e741d71c-cxxxxxxxx2b07556/oauth2/v2.0/token
authorizationUrl:https://login.microsoftonline.com/e741d71c-cxxxxxxxxx2b07556/oauth2/v2.0/token
Query Parameters
- @typestringEnum: [Voicemailbox]\@type qualifies the resource. It should be set to Voicemailbox for all voicemailbox operations.
Header Parameters
- AuthorizationstringRequiredJWT Bearer Token. Token URL: https://login.microsoftonline.com/e741d71c-cx03cxxxxxxx56/oauth2/v2.0/token See example below. curl --location --request POST 'https://login.microsoftonline.com/e741d71c-c6xx3c-xxxxx/oauth2/v2.0/token' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Cookie: fpc=Aswi39iZZIlGtV66yM1qCANKExLGAQAAAOqRbtgOAAAA; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd' --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' --data-urlencode 'grant_type=client_credentials' --data-urlencode 'client_id=6bb2748d-d916-4534-5148-ee8f598e1e00' --data-urlencode 'client_secret=k_43YrZE2S2v9o6__e.KOKc_V4h__csa3M' Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct on
- AcceptstringRequiredSpecifies the media type as "application/json".
- X-ATT-CorrelationIdstringRecommended format is 32 hexadecimal characters GUID (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX).
Body Parameters
- RequiredThis is a resource used to handle voicemail feature
- namestringA string used to give a name to the resource
- notearray of objects
- placeobjectRelated Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself
- @typestringWhen sub-classing, this defines the sub-class entity name
- categorystringCategory of the concrete resource. e.g Gold, Silver for MSISDN concrete resource
- @baseTypestringWhen sub-classing, this defines the super-class
- attachmentarray of objects
- usageStatestringEnum: [idle, active, busy]ResourceUsageStateType enumerations
- descriptionstringfree-text description of the resource
- relatedPartyarray of objects
- resourceStatusstringEnum: [standby, alarm, available, reserved, unknown, suspended]ResourceStatusType enumerations
- resourceVersionstringA field that identifies the specific version of an instance of a resource.
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationships
- endOperatingDatestringA date time( DateTime). The date till the resource is operating
- operationalStatestringEnum: [enable, disable]ResourceOperationalStateType enumerations
- activationFeatureConfiguration features
- startOperatingDatestringA date time( DateTime). The date from which the resource is operating
- administrativeStatestringEnum: [locked, unlocked, shutdown]ResourceAdministrativeStateType enumerations
- resourceRelationshiparray of objects
- resourceSpecificationobjectResource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.
- resourceCharacteristicarray of objects
- newPinstringNew Personal Identification NumberPattern: ^\d{4,20}$Length: 20
- subscriberNumberTypestringEnum: [DIALABLE]When using the phones dialable number use DIALABLE (instead of MSISDN) for both GSM and TDMA. For routing numbers use IMSI for just GSM, or MIN for just TDMA
- vmidstringwhen client sends vmid, will call snooper adapter directlyLength: 255
- wirelessLocalLoopIndicatorboolean
Responses
Updated
Body
application/json
- RequiredThis is a resource used to handle voicemail feature
- idstringIdentifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.
- hrefstringThe URI for the object itself.
- namestringA string used to give a name to the resource
- notearray of objects
- placeobjectRelated Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself
- @typestringWhen sub-classing, this defines the sub-class entity name
- categorystringCategory of the concrete resource. e.g Gold, Silver for MSISDN concrete resource
- @baseTypestringWhen sub-classing, this defines the super-class
- attachmentarray of objects
- usageStatestringEnum: [idle, active, busy]ResourceUsageStateType enumerations
- descriptionstringfree-text description of the resource
- relatedPartyarray of objects
- resourceStatusstringEnum: [standby, alarm, available, reserved, unknown, suspended]ResourceStatusType enumerations
- resourceVersionstringA field that identifies the specific version of an instance of a resource.
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationships
- endOperatingDatestringA date time( DateTime). The date till the resource is operating
- operationalStatestringEnum: [enable, disable]ResourceOperationalStateType enumerations
- activationFeatureConfiguration features
- startOperatingDatestringA date time( DateTime). The date from which the resource is operating
- administrativeStatestringEnum: [locked, unlocked, shutdown]ResourceAdministrativeStateType enumerations
- resourceRelationshiparray of objects
- resourceSpecificationobjectResource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.
- resourceCharacteristicarray of objects
- newPinstringPersonal Identification NumberLength: 20
- subscriberNumberTypestringEnum: [DIALABLE, IMSI, MIN]When using the phones dialable number use DIALABLE (instead of MSISDN) for both GSM and TDMA. For routing numbers use IMSI for just GSM, or MIN for just TDMA
- vmidstringwhen client sends vmid, will call snooper adapter directlyLength: 255
- wirelessLocalLoopIndicatorboolean
- codestring