Interface MeService

  • All Implemented Interfaces:

    
    public interface MeService
    
                        

    Retrieve account details

    • Constructor Detail

    • Method Detail

      • retrieve

         MeRetrieveResponse retrieve()

        Returns the account associated with the provided API key. The response includes account identity, contact information, messaging channel configuration, and — depending on the account type — either a list of child profiles or the profile's own settings.

        Account types:

        • organization — Has child profiles. The profiles array is populated.

        • user — Standalone account with no profiles.

        • profile — Child of an organization. Includes organization_id, short_name, status, and settings.

        Channels: The channels object always includes sms, whatsapp, and rcs. Each channel has a configured boolean. Configured channels expose additional details such as phone_number.