Package io.github.signalwirecommunity.repository

Class PhoneRepository

    • Constructor Summary

      Constructors 
      Constructor Description
      PhoneRepository​(java.lang.String projectId, java.lang.String apiToken, java.lang.String spaceUrl)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PhoneNumber createPhoneNumber​(java.lang.String areaCode, java.lang.String phoneNumber)
      Create a new phone number by providing the areaCode and phoneNumber
      PhoneNumber createPhoneNumber​(java.lang.String areaCode, java.lang.String phoneNumber, java.lang.String statusCallBack, java.lang.String friendlyName)
      Create a phone number by adding additional params like statusCallback, statuscallbackMethod
      SuccessResponse deletePhone​(java.lang.String sid)
      Delete a phone number from the project or a Space
      NumberResponse getLocalNumbers​(java.lang.String isoCountry)
      Get list of local numbers by ISO country
      PhoneResponse getPhoneNumber​(java.lang.String phoneNumber)
      Get list of phone number in a project by PhoneNumber
      PhoneNumber getPhoneNumberBySid​(java.lang.String sid)
      Get List of phone number in the project by SID
      PhoneResponse getPhoneNumbers()
      Get all the phone numbers in the project specified
      PhoneResponse getPhoneNumbers​(java.lang.String friendlyName)
      Get list of phone numbers by the friendlyName
      NumberResponse getTollFreeNumbers​(java.lang.String isoCountry)
      Get list of Toll Free numbers by ISO country value
      PhoneNumber transferPhoneNumber​(java.lang.String sid, java.lang.String accountId)
      Transfer a phone number from one space ID to another
      PhoneNumber update​(java.lang.String sid, java.lang.String smsUrl, java.lang.String voiceUrl)
      Update a phone number by SID and make changes to the SMS url and voice URL

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PhoneRepository

        public PhoneRepository​(java.lang.String projectId,
                       java.lang.String apiToken,
                       java.lang.String spaceUrl)

    • Method Detail

      • getPhoneNumbers

        public PhoneResponse getPhoneNumbers​(java.lang.String friendlyName)
        Get list of phone numbers by the friendlyName
        Specified by:
        getPhoneNumbers in interface PhoneInterface
        Parameters:
        friendlyName - name to query
        Returns:
        PhoneResponse

      • getPhoneNumber

        public PhoneResponse getPhoneNumber​(java.lang.String phoneNumber)
        Get list of phone number in a project by PhoneNumber
        Specified by:
        getPhoneNumber in interface PhoneInterface
        Parameters:
        phoneNumber - phone number to query
        Returns:
        PhoneResponse

      • getPhoneNumberBySid

        public PhoneNumber getPhoneNumberBySid​(java.lang.String sid)
        Get List of phone number in the project by SID
        Specified by:
        getPhoneNumberBySid in interface PhoneInterface
        Parameters:
        sid - unique SID of the phone number
        Returns:
        PhoneNumber

      • getTollFreeNumbers

        public NumberResponse getTollFreeNumbers​(java.lang.String isoCountry)
        Get list of Toll Free numbers by ISO country value
        Specified by:
        getTollFreeNumbers in interface PhoneInterface
        Parameters:
        isoCountry - ISO value of the country
        Returns:
        NumberResponse

      • getLocalNumbers

        public NumberResponse getLocalNumbers​(java.lang.String isoCountry)
        Get list of local numbers by ISO country
        Specified by:
        getLocalNumbers in interface PhoneInterface
        Parameters:
        isoCountry - ISO value of the country
        Returns:
        NumberResponse

      • createPhoneNumber

        public PhoneNumber createPhoneNumber​(java.lang.String areaCode,
                                     java.lang.String phoneNumber)
                              throws SignalWireException
        Create a new phone number by providing the areaCode and phoneNumber
        Specified by:
        createPhoneNumber in interface PhoneInterface
        Parameters:
        areaCode - areaCode of the phone number
        phoneNumber - value of the phone number to purchase
        Returns:
        PhoneNumber
        Throws:
        SignalWireException

      • createPhoneNumber

        public PhoneNumber createPhoneNumber​(java.lang.String areaCode,
                                     java.lang.String phoneNumber,
                                     java.lang.String statusCallBack,
                                     java.lang.String friendlyName)
                              throws SignalWireException
        Create a phone number by adding additional params like statusCallback, statuscallbackMethod
        Specified by:
        createPhoneNumber in interface PhoneInterface
        Parameters:
        areaCode - areaCode of the phone number
        phoneNumber - value of the phone number to purchase
        statusCallBack - statuscallback link for progress in phone call
        Returns:
        Throws:
        SignalWireException

      • update

        public PhoneNumber update​(java.lang.String sid,
                          java.lang.String smsUrl,
                          java.lang.String voiceUrl)
                   throws SignalWireException
        Update a phone number by SID and make changes to the SMS url and voice URL
        Specified by:
        update in interface PhoneInterface
        Parameters:
        sid - unique SID for the phone call
        smsUrl - SMS url information
        voiceUrl - Voice url information
        Returns:
        Throws:
        SignalWireException

      • transferPhoneNumber

        public PhoneNumber transferPhoneNumber​(java.lang.String sid,
                                       java.lang.String accountId)
                                throws SignalWireException
        Transfer a phone number from one space ID to another
        Specified by:
        transferPhoneNumber in interface PhoneInterface
        Parameters:
        sid - unique SID for the phone call
        accountId - unique id for the project from your space
        Returns:
        PhoneNumber
        Throws:
        SignalWireException

      • deletePhone

        public SuccessResponse deletePhone​(java.lang.String sid)
        Delete a phone number from the project or a Space
        Specified by:
        deletePhone in interface PhoneInterface
        Parameters:
        sid - unique SID for the phone call
        Returns:
        SuccessResponse