Telecom Egypt IM Developer Docs

Endpoint Details

SOAP Action

POST http://<IM_HOST>:<PORT>/services/EgyptWorkSheetAll

Namespace

http://service.ws.family.plugins.inspur.com

⚠

Request encoding: gb2312

The SOAP envelope must be sent with encoding="gb2312" in the XML declaration. The inner CDATA payload (the <form> block) must be URL-safe for XML embedding. The response is returned as UTF-8.

Authentication

Each request includes plaintext credentials in the CDATA body. These authenticate the OM system as a trusted caller.

Field	Type	Req.	Description	Example
authusername	string	Yes	Service account username for OM→IM integration	`OM_webservice`
authpassword	string	Yes	Password for the service account (masked in logs)	`********`

Top-Level Request Parameters

Field	Type	Req.	Description	Example
flowId	string	Yes	Unique flow identifier from OM. Used for deduplication and tracing.	`17808971600060235`
popid	string	Yes	Point of Presence ID — identifies the exchange area for this order.	`19608`
bussInfo	XML block	Yes	Container for one or more bussItem entries (usually one per request).

bussItem Fields

Each bussItem represents one service provisioning action:

Field	Type	Req.	Description	Example
opertype	string	Yes	Operation type: Install, Modify, Delete, Query	`Install`
coverType	string	Yes	Network access technology: ADSL, VDSL, FTTH	`ADSL`
serviceType	string	Yes	Technology type (mirrors coverType in most cases)	`ADSL`
serviceName	string	Yes	Specific service action name	`ADSL New Subscriber`
svFlag	string	No	Service flag (optional, contextual)
UserName	string	Yes	PPPoE username / subscriber login	`155800085@tedata.net.eg`
Password	string	Yes	PPPoE password (masked in IM storage)	`********`
AreaCode	string	Yes	Geographic area code for the installation	`57`
Serviceno	string	Yes	Service number (line/port identifier)	`FBB572243308`
CustomerOrderID	string	Yes	CRM order ID — primary reference across all systems	`20004189064385`
AccountNumber	string	Yes	Customer account number in CRM	`155800085`
ProductInstanceID	string	No	Product instance identifier from OM	`2019910001403565099`
CustomerName	string	Yes	Customer full name (supports Arabic)
CustomerCode	string	Yes	CRM customer code	`11044020160`
CustomerType	string	No	Customer segment type
CustomerPhone	string	No	Customer mobile number
CustomerEmail	string	No	Customer email (stored encrypted in IM)
CustomerLevel	string	No	VIP level classification
CustomerSegment	string	No	Segmentation code	`1`

attrList Fields (Technical/Resource Parameters)

These are the RFS (Resource Facing Service) parameters. Not all fields are populated for every service type — OM sends all parameters and empty values are allowed.

Field	Type	Req.	Description	Example
AccountID	string	No	Internal account ID	`11110719394`
ExchangeID	string	No	Exchange/DSLAM identifier (maps to IM_EXCHANGEDEV)	`19608`
ADSLPortalWOnumber	string	No	ADSL portal work order number	`7043`
homeAddress	string	No	Comma-separated address: Country,Gov,City,Street,No,Details
ActionType	string	No	Action type code (A=Add, M=Modify, D=Delete)	`A`
localloop	string	No	Local loop flag (0=No, 1=Yes)
FrameNumber	string	No	DSLAM frame number (for ADSL/VDSL)	`579`
SlotNumber	string	No	DSLAM slot number
PortNumber	string	No	DSLAM port number
CardNumber	string	No	Card number in the frame
Speed	string	No	Provisioned speed: downstream/upstream in kbps	`30720/15`
DslamIP	string	No	DSLAM IP address
DSLAM	string	No	DSLAM identifier
Dslamname	string	No	DSLAM name
OLTName	string	No	OLT name (FTTH only)
VLAN	string	No	VLAN ID (FTTH only)
WANIP	string	No	WAN IP address
SubnetMask	string	No	Subnet mask for static IP
LANIP	string	No	LAN IP address (Option Pack)
IPAddress	string	No	IP address for IP-Phone
CompoundId	string	No	Compound/building ID (FTTH)
SIPDomainName	string	No	SIP domain for IP-Phone
VoiceOfferID	string	No	Voice offer ID
VoiceOfferName	string	No	Voice offer name
DomainName	string	No	Domain name (Domain service)
Package	string	No	Service package
IPTVPassword	string	No	IPTV password (stored encrypted)
IPTVContent	string	No	IPTV content package
ParentUserName	string	No	Parent username (Family Filter)
ParentFilterType	string	No	Parent filter type
ChildUsername	string	No	Child username (Family Filter)
ChildFilterType	string	No	Child filter type
SecondFTTHPhone	string	No	Second FTTH phone number

Request / Response Examples

            SOAP Request — EgyptWorkSheetAll
            xml
        

<?xml version="1.0" encoding="gb2312"?>
<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ser="http://service.ws.family.plugins.inspur.com">

  <soapenv:Header/>
  <soapenv:Body>
    <ser:EgyptWorkSheetAll>
      <ser:in0><![CDATA[
        <form>
          <authusername>OM_webservice</authusername>
          <authpassword>********</authpassword>
          <flowId>17808971600060235</flowId>
          <popid>19608</popid>
          <bussInfo>
            <bussItem>
              <opertype>Install</opertype>
              <coverType>ADSL</coverType>
              <svFlag></svFlag>
              <serviceType>ADSL</serviceType>
              <serviceName>ADSL New Subscriber</serviceName>
              <UserName>155800085@tedata.net.eg</UserName>
              <Password>********</Password>
              <AreaCode>57</AreaCode>
              <Serviceno>FBB572243308</Serviceno>
              <CustomerOrderID>20004189064385</CustomerOrderID>
              <AccountNumber>155800085</AccountNumber>
              <ProductInstanceID>2019910001403565099</ProductInstanceID>
              <CustomerName>هناد احمد السيد الحناوى</CustomerName>
              <CustomerCode>11044020160</CustomerCode>
              <CustomerPhone>1034573308</CustomerPhone>
              <CustomerEmail></CustomerEmail>
              <CustomerSegment>1</CustomerSegment>
              <attrList>
                <AccountID>11110719394</AccountID>
                <IPAddress></IPAddress>
                <homeAddress>Domyat,Domyat,...</homeAddress>
                <ExchangeID>19608</ExchangeID>
                <ADSLPortalWOnumber>7043</ADSLPortalWOnumber>
                <ActionType>A</ActionType>
                <localloop>0</localloop>
                <FrameNumber>579</FrameNumber>
                <Speed>30720/15</Speed>
                <!-- FTTH-specific (empty for ADSL) -->
                <OLTName></OLTName>
                <VLAN></VLAN>
                <OntSN></OntSN>
                <CompoundId></CompoundId>
              </attrList>
              <IPPhoneExtensionList></IPPhoneExtensionList>
              <CPEList></CPEList>
            </bussItem>
          </bussInfo>
        </form>
      ]]></ser:in0>
    </ser:EgyptWorkSheetAll>
  </soapenv:Body>
</soapenv:Envelope>

            SOAP Response — Success (returnCode=0)
            xml
        

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <soap:Body>
    <ns1:EgyptWorkSheetAllResponse
      xmlns:ns1="http://service.ws.family.plugins.inspur.com">
      <ns1:out>
        <?xml version="1.0" encoding="UTF-8"?>
        <xml>
          <returnCode>0</returnCode>
          <errorCode>0</errorCode>
          <workitemid></workitemid>
          <errorDesc>success</errorDesc>
        </xml>
      </ns1:out>
    </ns1:EgyptWorkSheetAllResponse>
  </soap:Body>
</soap:Envelope>

            SOAP Response — Error (returnCode=1)
            xml
        

<xml>
  <returnCode>1</returnCode>
  <errorCode>-1002</errorCode>
  <workitemid></workitemid>
  <errorDesc>Authentication failed: invalid authusername or authpassword</errorDesc>
</xml>

Response Fields

Field	Type	Req.	Description	Example
returnCode	integer	Yes	0 = success, 1 = error
errorCode	integer	Yes	Detailed error code (0 = no error)
workitemid	string	No	Work item ID created in IM (may be empty)
errorDesc	string	Yes	Human-readable result message	`success`

💡

Always check returnCode first

A successful HTTP 200 response does NOT mean the operation succeeded — always parse the XML and check returnCode. Only returnCode=0 means IM accepted and processed the work order.