User Tools

Site Tools


Sidebar

apiv4:status:start

Status

…/api/v4/status

The status API in V4 brings multiple status objects together.

Note: The status API does not provide for manipulation of any system settings. Any changes must be made via the appropriate API interfaces for those components (i.e. the Settings API V4).

<status>
  <accountStatus>
    .
    .
  </accountStatus>
  <transcriptionStatus>
    .
    .
  </transcriptionStatus>
</status>

Hierarchy:

.../status
      |
      +-- /accountStatus
      |      |
      |      +-- /entitlements
      |      |
      |      +-- /features
      |      |
      |      +-- /ecommerceStatus
      |             |
      |             +-- /orders
      |
      +-- /transcriptionStatus

An HTTP GET of status will return a document that matches the above diagram. Each node will contain the various settings that apply to that node. There are NO settings directly parented to the status element.

NodeContains
accountStatusAccount related status
transcriptionStatusTranscription status

Sample

<?xml version="1.0" encoding="UTF-8"?>
<status>
    <accountStatus>
        <ecommerceStatus>
            <orders>
                <order>
                    <beginTime>1254938671000</beginTime>
                    <endTime>1263961010000</endTime>
                    <id>13118</id>
                    <orderType>1</orderType>
                    <productName>Read-It Saver Annual</productName>
                    <productSku>YMTRANSPREV50ANN</productSku>
                    <productType>10</productType>
                    <status>0</status>
                </order>
            </orders>
            <recommendations>
                <recommendation>
                    <mobileProductUrl>https://store.youmail.com/mstore/productTry.do?sku=YMPROANNUAL</mobileProductUrl>
                    <pitch>Never see ads again, plus get virtually unlimited storage for your voicemail messages!</pitch>
                    <productName>YouMail Pro</productName>
                    <productSku>YMPROANNUAL</productSku>
                    <productType>50</productType>
                    <recommendationType>1</recommendationType>
                    <unitPrice>19.99</unitPrice>
                    <webProductUrl>https://store.youmail.com/store/products/productView.do?sku=YMPROANNUAL</webProductUrl>
                </recommendation>
                <recommendation>
                    <mobileProductUrl>https://store.youmail.com/mstore/productTry.do?sku=YMTRANSFULL50</mobileProductUrl>
                    <pitch>Get started with YouMail Read-It transcription plans for just 6.99 a month.</pitch>
                    <productName>Read-It 50</productName>
                    <productSku>YMTRANSFULL50</productSku>
                    <productType>10</productType>
                    <recommendationType>1</recommendationType>
                    <unitPrice>6.99</unitPrice>
                    <webProductUrl>https://store.youmail.com/store/products/productView.do?sku=YMTRANSFULL50</webProductUrl>
                </recommendation>
            </recommendations>
            <trials>
                <order>
                    <beginTime>1267243325000</beginTime>
                    <endTime>0</endTime>
                    <id>14938</id>
                    <orderType>2</orderType>
                    <productName>Read-It Free Five</productName>
                    <productSku>YMTRANSFREE5</productSku>
                    <productType>10</productType>
                    <status>1</status>
                </order>
            </trials>
        </ecommerceStatus>
        <entitlements>
           <entitlement>
              <key>entitlement</key>
              <attributes>
                 <entry>
                    <key>contactMaxCount</key>
                    <value>10000</value>
                 </entry>
                 <entry>
                    <key>messageMaxLength</key>
                    <value>120</value>
                 </entry>
                 <entry>
                    <key>greetingMaxCount</key>
                    <value>500</value>
                 </entry>
                 <entry>
                    <key>maxNumberOfReceiptsPerMonth</key>
                    <value>10000</value>
                 </entry>
                 <entry>
                    <key>contactGroupMaxCount</key>
                    <value>100</value>
                 </entry>
                 <entry>
                    <key>messageFolderMaxCount</key>
                    <value>10</value>
                 </entry>
                 <entry>
                    <key>includePrivacyGuard</key>
                    <value>0</value>
                 </entry>
                 <entry>
                    <key>maxLinesOnAccount</key>
                    <value>1</value>
                 </entry>
                 <entry>
                    <key>messageMaxCount</key>
                    <value>100</value>
                 </entry>
                 <entry>
                    <key>maxNumberOfSmsPerMonth</key>
                    <value>10000</value>
                 </entry>
                 <entry>
                    <key>maxNonLocalDids</key>
                    <value>0</value>
                 </entry>
                 <entry>
                    <key>greetingSmartLevel</key>
                    <value>7</value>
                 </entry>
                 <entry>
                    <key>greetingMaxLength</key>
                    <value>30</value>
                 </entry>
                 <entry>
                    <key>adFreeWeb</key>
                    <value>0</value>
                 </entry>
                 <entry>
                    <key>adFreeApp</key>
                    <value>0</value>
                 </entry>
                 <entry>
                    <key>includeAudioAttachments</key>
                    <value>1</value>
                 </entry>
                 <entry>
                    <key>maxLocalDids</key>
                    <value>0</value>
                 </entry>
                 <entry>
                    <key>adFreeTxt</key>
                    <value>0</value>
                 </entry>
                 <entry>
                    <key>paidUser</key>
                    <value>0</value>
                 </entry>
              </attributes>
           </entitlement>
        </entitlements>
        <features>
            <feature>
                <id>5502</id>
                <key>trans</key>
                <description>Bait</description>
                <status>3</status>
                <inServiceTime>1278632130000</inServiceTime>
                <outOfServiceTime>0</outOfServiceTime>
            </feature>
        </features>
    </accountStatus>
    <transcriptionStatus>
        <active>false</active>
        <enabled>false</enabled>
        <freeCount>3</freeCount>
        <inactiveReason>Transcription Product time expired or max number of transcriptions allotted used.</inactiveReason>
        <planLifetimeTotalCount>8</planLifetimeTotalCount>
        <planMaxCount>5</planMaxCount>
        <planUsedCount>5</planUsedCount>
        <renewalDate>1898323200000</renewalDate>
    </transcriptionStatus>
</status>
apiv4/status/start.txt · Last modified: 2016/05/19 15:49 (external edit)

Page Tools