Junction Networks

Junction Networks Web Services API

DidRequest

Requests one or more DIDs (Phone Numbers) be assigned to a User.

Authentication

This action requires an Authenticated Session.

Authorization

This action requires Account Update permission.

Parameters

UserId
Required
A positive integer which references a unique User.
Protocol
Required
The protocol by which calls will be delivered to the user; 'sip' or 'iax'
NpaNxx[]
Required
An array mapping an NPA/NXX to a quantity. For example, NpaNxx[212789]=2 would indicate a request for 2 numbers from Area Code 212 with an NXX of 789.

Result RELAX NG Schema Modules

Main module: DidRequest.rng

Supporting modules:  Did.rng  User.rng

Result Element Example

        
          
        
<!-- 
Here is the matching request for this example:
  restapi?SessionId=1234567890abcdefghijklmino&Action=DidRequest&UserId=1234567&Protocol=sip&NpaNxx[212789]=1 
-->

<Result>
  <DidRequest>
    <Requested>1</Requested>
    <Filled>1</Filled>
    <Dids>
      <Did>
        <DidId>16788</DidId>
        <UserId>1234567</UserId>
        <OrganizationId>2</OrganizationId>
        <AccountId>1</AccountId>
        <UserStatus>enabled</UserStatus>
        <Number>12127891234</Number>
        <Protocol>sip</Protocol>
        <Timeout>120</Timeout>
        <FailoverEnabled>true</FailoverEnabled>
        <FailoverProtocol>pstn</FailoverProtocol>
        <FailoverLocation/>
        <VoicemailboxId/>
        <CallerIdNumberRequired>false</CallerIdNumberRequired>
        <SimultaniousCallLimit>25</SimultaniousCallLimit>
        <Created>2006-12-20T15:22:15-05:00</Created>
        <Note/>
      </Did>
    </Dids>
    <User>
      <UserId>1234567</UserId>
      <OrganizationId>1234567</OrganizationId>
      <AccountId>1234567</AccountId>
      <Flags>3</Flags>
      <Status>enabled</Status>
      <Domain>example.onsip.com</Domain>
      <Username>example</Username>
      <Password>HqSVV6Wk</Password>
      <AuthUsername>example</AuthUsername>
      <Modified>2006-12-19T21:53:56-05:00</Modified>
      <Created>2005-02-01T15:04:08-05:00</Created>
      <Ack911>2005-07-26T20:50:52-04:00</Ack911>
      <ExtendedDialing>true</ExtendedDialing>
      <PSTNForwarding>true</PSTNForwarding>
      <Contact>
        <Name>Example User</Name>
        <Organization>Junction Networks</Organization>
        <Address>11 Junction St.</Address>
        <City>Brooklyn</City>
        <State>NY</State>
        <Zipcode>11201</Zipcode>
        <Country>United States of America</Country>
        <CountryId>207</CountryId>
        <Phone>1-917-555-1234</Phone>
        <Email>example@junctionnetworks.com</Email>
        <Modified>2006-12-19T21:53:56-05:00</Modified>
      </Contact>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </User>
  </DidRequest>
</Result>